Skip to content

Commit 27f8905

Browse files
Merge pull request #1011 from carmiker/master
Update Nestopia-related docs
2 parents eaf9e5d + a0e22d8 commit 27f8905

37 files changed

+66
-70
lines changed

docs/development/licenses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
160160
| Mupen64Plus GLES3 | [GPLv3](https://github.com/libretro/mupen64plus-libretro/blob/master/LICENSE) | |
161161
| Neko Project II | | |
162162
| Neko Project II Kai | [MIT](https://github.com/AZO234/NP2kai/blob/master/LICENSE) | |
163-
| [Nestopia UE](../library/nestopia_ue.md) | [GPLv2](https://github.com/libretro/nestopia/blob/master/COPYING) | |
163+
| [Nestopia](../library/nestopia.md) | [GPLv2](https://github.com/libretro/nestopia/blob/master/COPYING) | |
164164
| [Numero](../library/numero.md) | [GPLv2](https://github.com/nbarkhina/numero/blob/master/LICENSE) | |
165165
| nSide Balanced | [GPLv3](https://github.com/hex-usr/nSide/blob/master/gpl-3.0.txt) | |
166166
| [NXEngine](../library/nxengine.md) | [GPLv3](https://github.com/gameblabla/nxengine-nspire/blob/master/LICENSE) | |

docs/guides/core-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@
138138
| Neko Project II | NEC PC-98 | |
139139
| Neko Project II Kai | NEC PC-98 | |
140140
| NeoCD | Neo Geo CD | |
141-
| Nestopia UE | Nintendo NES/Famicom | |
141+
| Nestopia | Nintendo NES/Famicom | |
142142
| nSide Balanced | Nintendo SNES/SFC/Game Boy/Color | |
143143
| Numero | TI-83 | A TI-83 Emulator for Libretro |
144144
| NXEngine | Game engine | An open-source reimplementation of the Cave Story / Doukutsu engine |

docs/guides/retroachievements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ You can also check the progress of your friends and add comments on their trophi
220220
| [Mesen](https://github.com/SourMesen/Mesen) || Supports FDS, very high accuracy, relatively high performance cost |
221221
| [FCEUmm](https://github.com/libretro/libretro-fceumm) || Supports FDS |
222222
| [QuickNES](https://github.com/libretro/QuickNES_Core) || |
223-
| [Nestopia UE](https://github.com/libretro/nestopia) || [**Achievements are not fully supported yet**](https://github.com/libretro/docs/pull/10) |
223+
| [Nestopia](https://github.com/libretro/nestopia) || [**Achievements are not fully supported yet**](https://github.com/libretro/docs/pull/10) |
224224
| [bnes](https://github.com/libretro/bnes-libretro) || |
225225
| [Emux NES](https://github.com/libretro/emux) || |
226226
| [FinalBurn Neo](https://github.com/libretro/FBNeo) || |

docs/guides/softpatching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rom.ips2
5555
| [bnes](../library/bnes.md) ||
5656
| [FCEUmm](../library/fceumm.md) ||
5757
| [Mesen](../library/mesen.md) ||
58-
| [Nestopia UE](../library/nestopia_ue.md) ||
58+
| [Nestopia](../library/nestopia.md) ||
5959
| [QuickNES](../library/quicknes.md) ||
6060

6161
### Nintendo - SNES / Famicom

docs/library/bios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ MS/MD/CD/32X | PicoDrive | [BIOS information](picodriv
7676
MSX/SVI/ColecoVision/SG-1000 | blueMSX | [BIOS information](bluemsx.md#bios)
7777
MSX | fMSX | [BIOS information](fmsx.md#bios)
7878
NES/Famicom | FCEUmm | [BIOS information](fceumm.md#bios)
79-
NES/Famicom | Nestopia UE | [BIOS information](nestopia_ue.md#bios)
79+
NES/Famicom | Nestopia | [BIOS information](nestopia.md#bios)
8080
NES/Famicom | Mesen | [BIOS information](mesen.md#bios)
8181
Odyssey2/Videopac+ | O2EM | [BIOS information](o2em.md#bios)
8282
PC-98 | Neko Project II Kai| [BIOS information](neko_project_ii_kai.md#bios)

docs/library/bnes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,5 @@ The bnes core supports the following device type(s) in the controls menu, bolded
135135
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
136136
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
137137
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
138-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
139-
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
138+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
139+
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)

docs/library/emux_nes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,5 +116,5 @@ Awaiting description.
116116
- [Nintendo - NES / Famicom (bnes)](bnes.md)
117117
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
118118
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
119-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
120-
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
119+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
120+
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)

docs/library/fceumm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,12 +419,12 @@ The FCEUmm core supports up to 4 players in multitap games for the NES and Famic
419419
#### Nintendo - Family Computer Disk System
420420

421421
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
422-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
422+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
423423

424424
#### Nintendo - Nintendo Entertainment System
425425

426426
- [Nintendo - NES / Famicom (bnes)](bnes.md)
427427
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
428428
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
429-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
429+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
430430
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)

docs/library/mesen.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,12 +422,12 @@ Multitap support can be activated in the Mesen core by switching User 5's device
422422
#### Nintendo - Family Computer Disk System
423423

424424
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
425-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
425+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
426426

427427
#### Nintendo - Nintendo Entertainment System
428428

429429
- [Nintendo - NES / Famicom (bnes)](bnes.md)
430430
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
431431
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
432-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
432+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
433433
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)

docs/library/nestopia_ue.md renamed to docs/library/nestopia.md

Lines changed: 50 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
# Nintendo - NES / Famicom (Nestopia UE)
1+
# Nintendo - NES / Famicom (Nestopia)
22

33
## Background
44

5-
Nestopia is a portable and cycle-accurate NES/Famicom emulator written in C++. Nestopia UE (Undead Edition) is a fork of the original source code, with enhancements from members of the emulation community. This includes support for new platforms, and bug fixes in the emulator core.
5+
Nestopia is a cycle accurate emulator for the NES/Famicom.
6+
This is the libretro port of the Nestopia emulator, based on the de facto
7+
upstream Nestopia JG fork. The libretro port contains an additional overclocking feature.
68

79
### Author/License
810

9-
The Nestopia UE core has been authored by
11+
The Nestopia core has been authored by
1012

1113
- Martin Freij
12-
- R. Belmont
1314
- R. Danbrook
15+
- [Rupert Carmichael (carmiker)](https://github.com/carmiker)
1416

15-
The Nestopia UE core is licensed under
17+
The Nestopia core is licensed under
1618

1719
- [GPLv2](https://github.com/libretro/nestopia/blob/master/COPYING)
1820

1921
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
2022

2123
## Extensions
2224

23-
Content that can be loaded by the Nestopia UE core have the following file extensions:
25+
Content that can be loaded by the Nestopia core have the following file extensions:
2426

2527
- .nes
2628
- .fds
@@ -29,7 +31,7 @@ Content that can be loaded by the Nestopia UE core have the following file exten
2931

3032
## Databases
3133

32-
RetroArch database(s) that are associated with the Nestopia UE core:
34+
RetroArch database(s) that are associated with the Nestopia core:
3335

3436
- [Nintendo - Nintendo Entertainment System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Nintendo%20Entertainment%20System.rdb)
3537
- [Nintendo - Family Computer Disk System](https://github.com/libretro/libretro-database/blob/master/rdb/Nintendo%20-%20Family%20Computer%20Disk%20System.rdb)
@@ -39,15 +41,15 @@ RetroArch database(s) that are associated with the Nestopia UE core:
3941
Required or optional firmware files go in the frontend's system directory.
4042

4143
!!! warning
42-
Prior to Nestopia UE 1.50, it required the [NstDatabase.xml](#nstdatabasexml) file for general proper emulation. In version 1.50 or higher, it's baked into the core.
44+
Prior to version 1.50, it required the [NstDatabase.xml](#nstdatabasexml) file for general proper emulation. In version 1.50 or higher, it's baked into the core.
4345

4446
| Filename | Description | md5sum |
4547
|:---------------:|:-----------------------------------------------------------------------------:|:--------------------------------:|
4648
| disksys.rom | Family Computer Disk System BIOS - Required for Famicom Disk System emulation | ca30b50f880eb660a320674ed365ef7a |
4749

4850
## Features
4951

50-
Frontend-level settings or features that the Nestopia UE core respects.
52+
Frontend-level settings or features that the Nestopia core respects.
5153

5254
| Feature | Supported |
5355
|-------------------|:---------:|
@@ -78,9 +80,9 @@ Frontend-level settings or features that the Nestopia UE core respects.
7880

7981
### Directories
8082

81-
The Nestopia UE core's internal core name is 'Nestopia'
83+
The Nestopia core's internal core name is 'Nestopia'
8284

83-
The Nestopia UE core saves/loads to/from these directories.
85+
The Nestopia core saves/loads to/from these directories.
8486

8587
**Frontend's Save directory**
8688

@@ -96,13 +98,13 @@ The Nestopia UE core saves/loads to/from these directories.
9698

9799
### Geometry and timing
98100

99-
- The Nestopia UE core's core provided FPS is (FPS)
100-
- The Nestopia UE core's core provided sample rate is 44100 Hz
101-
- The Nestopia UE core's core provided aspect ratio is dependent on the ['Preferred aspect ratio' core option](#core-options).
101+
- The Nestopia core's core provided FPS is (FPS)
102+
- The Nestopia core's core provided sample rate is 44100 Hz
103+
- The Nestopia core's core provided aspect ratio is dependent on the ['Preferred aspect ratio' core option](#core-options).
102104

103105
### NstDatabase.xml
104106

105-
The Nestopia UE core relies on the internal database (built from the NstDatabase.xml file) for
107+
The Nestopia core relies on the internal database (built from the NstDatabase.xml file) for
106108

107109
- Games that support a custom mapper
108110
- Games that support multitap accessories
@@ -113,7 +115,7 @@ The Nestopia UE core relies on the internal database (built from the NstDatabase
113115

114116
### Custom color palettes
115117

116-
To use custom color palettes in the Nestopia UE core, the custom color palette file you want to use must be in RetroArch's system directory.
118+
To use custom color palettes in the Nestopia core, the custom color palette file you want to use must be in RetroArch's system directory.
117119

118120
Make sure the custom palette file is named 'custom.pal'
119121

@@ -126,7 +128,7 @@ Custom color palettes for the NES can be generated with either of these tools.
126128

127129
## Core options
128130

129-
The Nestopia UE core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
131+
The Nestopia core has the following option(s) that can be tweaked from the core options menu. The default setting is bolded.
130132

131133
Settings with (Restart) means that core has to be closed for the new setting to be applied on next launch.
132134

@@ -138,19 +140,19 @@ Settings with (Restart) means that core has to be closed for the new setting to
138140
These 'Blargg NTSC filter' core option screenshots have been taken with the 'Palette' core option set to cxa2025as.
139141

140142
??? note "Blargg NTSC filter - Off"
141-
![](../image/core/nestopia_ue/blargg_off.png)
143+
![](../image/core/nestopia/blargg_off.png)
142144

143145
??? note "Blargg NTSC filter - composite"
144-
![](../image/core/nestopia_ue/blargg_composite.png)
146+
![](../image/core/nestopia/blargg_composite.png)
145147

146148
??? note "Blargg NTSC filter - svideo"
147-
![](../image/core/nestopia_ue/blargg_svideo.png)
149+
![](../image/core/nestopia/blargg_svideo.png)
148150

149151
??? note "Blargg NTSC filter - rgb"
150-
![](../image/core/nestopia_ue/blargg_rgb.png)
152+
![](../image/core/nestopia/blargg_rgb.png)
151153

152154
??? note "Blargg NTSC filter - monochrome"
153-
![](../image/core/nestopia_ue/blargg_monochrome.png)
155+
![](../image/core/nestopia/blargg_monochrome.png)
154156

155157
- **Palette** [nestopia_palette] (**cxa2025as**|consumer|canonical|alternative|rgb|pal|composite-direct-fbx|pvm-style-d93-fbx|ntsc-hardware-fbx|nes-classic-fbx-fs|raw|custom)
156158

@@ -160,37 +162,37 @@ Settings with (Restart) means that core has to be closed for the new setting to
160162
These 'Palette' core option screenshots have been taken with the 'Blargg NTSC filter' core option set to Off.
161163

162164
??? note "Palette - cxa2025as"
163-
![](../image/core/nestopia_ue/cxa2025as.png)
165+
![](../image/core/nestopia/cxa2025as.png)
164166

165167
??? note "Palette - consumer"
166-
![](../image/core/nestopia_ue/consumer.png)
168+
![](../image/core/nestopia/consumer.png)
167169

168170
??? note "Palette - canonical"
169-
![](../image/core/nestopia_ue/canonical.png)
171+
![](../image/core/nestopia/canonical.png)
170172

171173
??? note "Palette - alternative"
172-
![](../image/core/nestopia_ue/alternative.png)
174+
![](../image/core/nestopia/alternative.png)
173175

174176
??? note "Palette - rgb"
175-
![](../image/core/nestopia_ue/rgb.png)
177+
![](../image/core/nestopia/rgb.png)
176178

177179
??? note "Palette - pal"
178-
![](../image/core/nestopia_ue/pal.png)
180+
![](../image/core/nestopia/pal.png)
179181

180182
??? note "Palette - composite-direct-fbx"
181-
![](../image/core/nestopia_ue/composite_direct_fbx.png)
183+
![](../image/core/nestopia/composite_direct_fbx.png)
182184

183185
??? note "Palette - pvm-style-d93-fbx"
184-
![](../image/core/nestopia_ue/pvm_style_d93_fbx.png)
186+
![](../image/core/nestopia/pvm_style_d93_fbx.png)
185187

186188
??? note "Palette - ntsc-hardware-fbx"
187-
![](../image/core/nestopia_ue/ntsc_hardware_fbx.png)
189+
![](../image/core/nestopia/ntsc_hardware_fbx.png)
188190

189191
??? note "Palette - nes-classic-fbx-fs"
190-
![](../image/core/nestopia_ue/nes_classic_fbx_fs.png)
192+
![](../image/core/nestopia/nes_classic_fbx_fs.png)
191193

192194
??? note "Palette - raw"
193-
![](../image/core/nestopia_ue/raw.png)
195+
![](../image/core/nestopia/raw.png)
194196

195197
- **Remove Sprite Limit** [nestopia_nospritelimit] (**disabled**|enabled)
196198

@@ -213,33 +215,33 @@ Settings with (Restart) means that core has to be closed for the new setting to
213215
Mask out (vertically) the potentially random glitchy video output that would have been hidden by the bezel around the edge of a standard-definition television screen.
214216

215217
??? note "Mask Overscan (Vertical) - On"
216-
![](../image/core/nestopia_ue/vert_on.png)
218+
![](../image/core/nestopia/vert_on.png)
217219

218220
??? note "Mask Overscan (Vertical) - Off"
219-
![](../image/core/nestopia_ue/vert_off.png)
221+
![](../image/core/nestopia/vert_off.png)
220222

221223
- **Mask Overscan (Horizontal)** [nestopia_overscan_h] (**disabled**|enabled)
222224

223225
Mask out (horizontally) the potentially random glitchy video output that would have been hidden by the bezel around the edge of a standard-definition television screen.
224226

225227
??? note "Mask Overscan (Horizontal) - Off"
226-
![](../image/core/nestopia_ue/horiz_off.png)
228+
![](../image/core/nestopia/horiz_off.png)
227229

228230
??? note "Mask Overscan (Horizontal) - On"
229-
![](../image/core/nestopia_ue/horiz_on.png)
231+
![](../image/core/nestopia/horiz_on.png)
230232

231233
- **Preferred aspect ratio** [nestopia_aspect] (**auto**|ntsc|pal|4:3)
232234

233235
Choose the preferred aspect ratio. RetroArch's aspect ratio must be set to Core provided in the Video settings. 'auto' will use the [internal database](#nstdatabasexml) for aspect ratio autodetection.
234236

235237
??? note "Preferred aspect ratio - ntsc"
236-
![](../image/core/nestopia_ue/ratio_ntsc.png)
238+
![](../image/core/nestopia/ratio_ntsc.png)
237239

238240
??? note "Preferred aspect ratio - pal"
239-
![](../image/core/nestopia_ue/ratio_pal.png)
241+
![](../image/core/nestopia/ratio_pal.png)
240242

241243
??? note "Preferred aspect ratio - 4:3"
242-
![](../image/core/nestopia_ue/ratio_4by3.png)
244+
![](../image/core/nestopia/ratio_4by3.png)
243245

244246
- **Game Genie Sound Distortion** [nestopia_genie_distortion] (**disabled**|enabled)
245247

@@ -259,19 +261,19 @@ Settings with (Restart) means that core has to be closed for the new setting to
259261

260262
## Controllers
261263

262-
The Nestopia UE core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):
264+
The Nestopia core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):
263265

264266
### User 1 - 4 device types
265267

266268
- None - Disables input.
267269
- **Auto** - Automatically detects the device to use based on the internal database.
268270
- Gamepad - Joypad
269271
- Arkanoid - Arkanoid paddle - This should be automatic from the internal database, but this can be changed to Gamepad if you'd prefer using a joypad rather than a paddle. (Port 2 only)
270-
- Zapper - Lightgun - The Nestopia UE core can emulate Zapper inputs. This is generally done automatically based off of the internal database, but can be manually selected as a device type. (Port 2 only)
272+
- Zapper - Lightgun - The Nestopia core can emulate Zapper inputs. This is generally done automatically based off of the internal database, but can be manually selected as a device type. (Port 2 only)
271273

272274
### Multitap support
273275

274-
The Nestopia UE core uses the internal database to detect which games have multitap support.
276+
The Nestopia core uses the internal database to detect which games have multitap support.
275277

276278
### Controller tables
277279

@@ -322,20 +324,14 @@ The Nestopia UE core uses the internal database to detect which games have multi
322324

323325
## Compatibility
324326

325-
| Game | Issue |
326-
|------------------------|----------------------------------------------------------------- |
327-
| Skull & Crossbones | Graphical glitches and screen shaking when in 2-player mode. (1) |
328-
329-
??? note "(1)"
330-
![](../image/core/nestopia_ue/skull.png)
327+
The Nestopia core is compatible with 100% of officially released titles, and the vast majority of homebrew and hacks.
331328

332329
## External Links
333330

334-
- [Official Nestopia UE Website](http://0ldsk00l.ca/nestopia/)
335-
- [Official Nestopia UE Github Repository](https://github.com/0ldsk00l/nestopia)
336-
- [Libretro Nestopia UE Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/nestopia_libretro.info)
337-
- [Libretro Nestopia UE Github Repository](https://github.com/libretro/nestopia)
338-
- [Report Libretro Nestopia UE Core Issues Here](https://github.com/libretro/nestopia/issues)
331+
- [Upstream Nestopia JG Repository](https://gitlab.com/jgemu/nestopia)
332+
- [Libretro Nestopia Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/nestopia_libretro.info)
333+
- [Libretro Nestopia Github Repository](https://github.com/libretro/nestopia)
334+
- [Report Libretro Nestopia Core Issues Here](https://github.com/libretro/nestopia/issues)
339335

340336
### See also
341337

docs/library/quicknes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,4 +228,4 @@ Settings with (Restart) means that core has to be closed for the new setting to
228228
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
229229
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
230230
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
231-
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
231+
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)

0 commit comments

Comments
 (0)