Skip to content

Commit 0d0fafc

Browse files
authored
Merge pull request #1155 from doublegate/feat/add-rustynes-core-v2
docs: Add RustyNES core documentation page
2 parents 1568ddf + bbc479a commit 0d0fafc

2 files changed

Lines changed: 86 additions & 0 deletions

File tree

‎docs/library/rustynes.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Nintendo - NES / Famicom (RustyNES)
2+
3+
## Background
4+
5+
RustyNES is a cycle-accurate Nintendo Entertainment System (NES) and Famicom emulator written entirely in pure Rust. It targets the highest accuracy bar (comparable to Mesen and higan) through strict lockstep timing at PPU-dot resolution, without relying on threading or standard library timing.
6+
7+
It is extremely portable and deterministic, making it a reliable choice for netplay, TAS, and accurate emulation enthusiasts.
8+
9+
### Author/License
10+
11+
The RustyNES core has been authored by
12+
13+
- DoubleGate
14+
15+
The RustyNES core is licensed under
16+
17+
- MIT OR Apache-2.0
18+
19+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
20+
21+
## Extensions
22+
23+
Content that can be loaded by the RustyNES core have the following file extensions:
24+
25+
- .nes
26+
27+
## Databases
28+
29+
RetroArch database(s) that are associated with the RustyNES core:
30+
31+
- [Nintendo - Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20Entertainment%20System.rdb)
32+
33+
## Features
34+
35+
Frontend-level settings or features that the RustyNES core respects.
36+
37+
| Feature | Supported |
38+
|-------------------|:---------:|
39+
| Restart | ✔ |
40+
| Screenshots | ✔ |
41+
| Saves | ✔ |
42+
| States | ✔ |
43+
| Rewind | ✔ |
44+
| Netplay | ✔ |
45+
| Core Options | ✕ |
46+
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
47+
| RetroArch Cheats | ✕ |
48+
| Native Cheats | ✕ |
49+
| Controls | ✔ |
50+
| Remapping | ✔ |
51+
| Multi-Mouse | ✕ |
52+
| Rumble | ✕ |
53+
| Sensors | ✕ |
54+
| Camera | ✕ |
55+
| Location | ✕ |
56+
| Subsystem | ✕ |
57+
| [Softpatching](../guides/softpatching.md) | ✔ |
58+
| Disk Control | ✕ |
59+
| Username | ✕ |
60+
| Language | ✕ |
61+
| Crop Overscan | ✕ |
62+
| Active Touchpad | ✕ |
63+
64+
## Directories
65+
66+
The RustyNES core's directory name is 'RustyNES'.
67+
68+
### BIOS
69+
70+
No BIOS files are strictly required to use the RustyNES core.
71+
72+
## Joypad
73+
74+
![](../image/controller/nes.png)
75+
76+
| User 1 - 2 input descriptors | RetroPad Inputs |
77+
|------------------------------|-------------------------------------------|
78+
| B | ![](../image/retropad/retro_b.png) |
79+
| A | ![](../image/retropad/retro_a.png) |
80+
| Select | ![](../image/retropad/retro_select.png) |
81+
| Start | ![](../image/retropad/retro_start.png) |
82+
| D-Pad Up | ![](../image/retropad/retro_dpad_up.png) |
83+
| D-Pad Down | ![](../image/retropad/retro_dpad_down.png)|
84+
| D-Pad Left | ![](../image/retropad/retro_dpad_left.png)|
85+
| D-Pad Right | ![](../image/retropad/retro_dpad_right.png)|

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ nav:
199199
- 'Nintendo - NES / Famicom (Mesen)': 'library/mesen.md'
200200
- 'Nintendo - NES / Famicom (Nestopia)': 'library/nestopia.md'
201201
- 'Nintendo - NES / Famicom (QuickNES)': 'library/quicknes.md'
202+
- 'Nintendo - NES / Famicom (RustyNES)': 'library/rustynes.md'
202203
- 'Nintendo - 3DS (Citra)': 'library/citra.md'
203204
- 'Nintendo - 3DS (Citra Canary/Experimental)': 'library/citra_canary.md'
204205
- 'Nintendo - Nintendo 64 (Mupen64Plus)': 'library/mupen64plus.md'

0 commit comments

Comments
 (0)