Skip to content

Commit

Permalink
Merge pull request #1011 from carmiker/master
Browse files Browse the repository at this point in the history
Update Nestopia-related docs
  • Loading branch information
LibretroAdmin authored Dec 23, 2024
2 parents eaf9e5d + a0e22d8 commit 27f8905
Show file tree
Hide file tree
Showing 37 changed files with 66 additions and 70 deletions.
2 changes: 1 addition & 1 deletion docs/development/licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
| Mupen64Plus GLES3 | [GPLv3](https://github.com/libretro/mupen64plus-libretro/blob/master/LICENSE) | |
| Neko Project II | | |
| Neko Project II Kai | [MIT](https://github.com/AZO234/NP2kai/blob/master/LICENSE) | |
| [Nestopia UE](../library/nestopia_ue.md) | [GPLv2](https://github.com/libretro/nestopia/blob/master/COPYING) | |
| [Nestopia](../library/nestopia.md) | [GPLv2](https://github.com/libretro/nestopia/blob/master/COPYING) | |
| [Numero](../library/numero.md) | [GPLv2](https://github.com/nbarkhina/numero/blob/master/LICENSE) | |
| nSide Balanced | [GPLv3](https://github.com/hex-usr/nSide/blob/master/gpl-3.0.txt) | |
| [NXEngine](../library/nxengine.md) | [GPLv3](https://github.com/gameblabla/nxengine-nspire/blob/master/LICENSE) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/core-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
| Neko Project II | NEC PC-98 | |
| Neko Project II Kai | NEC PC-98 | |
| NeoCD | Neo Geo CD | |
| Nestopia UE | Nintendo NES/Famicom | |
| Nestopia | Nintendo NES/Famicom | |
| nSide Balanced | Nintendo SNES/SFC/Game Boy/Color | |
| Numero | TI-83 | A TI-83 Emulator for Libretro |
| NXEngine | Game engine | An open-source reimplementation of the Cave Story / Doukutsu engine |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/retroachievements.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ You can also check the progress of your friends and add comments on their trophi
| [Mesen](https://github.com/SourMesen/Mesen) || Supports FDS, very high accuracy, relatively high performance cost |
| [FCEUmm](https://github.com/libretro/libretro-fceumm) || Supports FDS |
| [QuickNES](https://github.com/libretro/QuickNES_Core) || |
| [Nestopia UE](https://github.com/libretro/nestopia) || [**Achievements are not fully supported yet**](https://github.com/libretro/docs/pull/10) |
| [Nestopia](https://github.com/libretro/nestopia) || [**Achievements are not fully supported yet**](https://github.com/libretro/docs/pull/10) |
| [bnes](https://github.com/libretro/bnes-libretro) || |
| [Emux NES](https://github.com/libretro/emux) || |
| [FinalBurn Neo](https://github.com/libretro/FBNeo) || |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/softpatching.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ rom.ips2
| [bnes](../library/bnes.md) ||
| [FCEUmm](../library/fceumm.md) ||
| [Mesen](../library/mesen.md) ||
| [Nestopia UE](../library/nestopia_ue.md) ||
| [Nestopia](../library/nestopia.md) ||
| [QuickNES](../library/quicknes.md) ||

### Nintendo - SNES / Famicom
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/library/bios.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ MS/MD/CD/32X | PicoDrive | [BIOS information](picodriv
MSX/SVI/ColecoVision/SG-1000 | blueMSX | [BIOS information](bluemsx.md#bios)
MSX | fMSX | [BIOS information](fmsx.md#bios)
NES/Famicom | FCEUmm | [BIOS information](fceumm.md#bios)
NES/Famicom | Nestopia UE | [BIOS information](nestopia_ue.md#bios)
NES/Famicom | Nestopia | [BIOS information](nestopia.md#bios)
NES/Famicom | Mesen | [BIOS information](mesen.md#bios)
Odyssey2/Videopac+ | O2EM | [BIOS information](o2em.md#bios)
PC-98 | Neko Project II Kai| [BIOS information](neko_project_ii_kai.md#bios)
Expand Down
4 changes: 2 additions & 2 deletions docs/library/bnes.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,5 @@ The bnes core supports the following device type(s) in the controls menu, bolded
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
4 changes: 2 additions & 2 deletions docs/library/emux_nes.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,5 @@ Awaiting description.
- [Nintendo - NES / Famicom (bnes)](bnes.md)
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
4 changes: 2 additions & 2 deletions docs/library/fceumm.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,12 +419,12 @@ The FCEUmm core supports up to 4 players in multitap games for the NES and Famic
#### Nintendo - Family Computer Disk System

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

#### Nintendo - Nintendo Entertainment System

- [Nintendo - NES / Famicom (bnes)](bnes.md)
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
4 changes: 2 additions & 2 deletions docs/library/mesen.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,12 +422,12 @@ Multitap support can be activated in the Mesen core by switching User 5's device
#### Nintendo - Family Computer Disk System

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

#### Nintendo - Nintendo Entertainment System

- [Nintendo - NES / Famicom (bnes)](bnes.md)
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
- [Nintendo - NES / Famicom (QuickNES)](quicknes.md)
104 changes: 50 additions & 54 deletions docs/library/nestopia_ue.md → docs/library/nestopia.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
# Nintendo - NES / Famicom (Nestopia UE)
# Nintendo - NES / Famicom (Nestopia)

## Background

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.
Nestopia is a cycle accurate emulator for the NES/Famicom.
This is the libretro port of the Nestopia emulator, based on the de facto
upstream Nestopia JG fork. The libretro port contains an additional overclocking feature.

### Author/License

The Nestopia UE core has been authored by
The Nestopia core has been authored by

- Martin Freij
- R. Belmont
- R. Danbrook
- [Rupert Carmichael (carmiker)](https://github.com/carmiker)

The Nestopia UE core is licensed under
The Nestopia core is licensed under

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

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

## Extensions

Content that can be loaded by the Nestopia UE core have the following file extensions:
Content that can be loaded by the Nestopia core have the following file extensions:

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

## Databases

RetroArch database(s) that are associated with the Nestopia UE core:
RetroArch database(s) that are associated with the Nestopia core:

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

!!! warning
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.
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.

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

## Features

Frontend-level settings or features that the Nestopia UE core respects.
Frontend-level settings or features that the Nestopia core respects.

| Feature | Supported |
|-------------------|:---------:|
Expand Down Expand Up @@ -78,9 +80,9 @@ Frontend-level settings or features that the Nestopia UE core respects.

### Directories

The Nestopia UE core's internal core name is 'Nestopia'
The Nestopia core's internal core name is 'Nestopia'

The Nestopia UE core saves/loads to/from these directories.
The Nestopia core saves/loads to/from these directories.

**Frontend's Save directory**

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

### Geometry and timing

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

### NstDatabase.xml

The Nestopia UE core relies on the internal database (built from the NstDatabase.xml file) for
The Nestopia core relies on the internal database (built from the NstDatabase.xml file) for

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

### Custom color palettes

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.
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.

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

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

## Core options

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

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

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

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

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

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

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

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

- **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)

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

??? note "Palette - cxa2025as"
![](../image/core/nestopia_ue/cxa2025as.png)
![](../image/core/nestopia/cxa2025as.png)

??? note "Palette - consumer"
![](../image/core/nestopia_ue/consumer.png)
![](../image/core/nestopia/consumer.png)

??? note "Palette - canonical"
![](../image/core/nestopia_ue/canonical.png)
![](../image/core/nestopia/canonical.png)

??? note "Palette - alternative"
![](../image/core/nestopia_ue/alternative.png)
![](../image/core/nestopia/alternative.png)

??? note "Palette - rgb"
![](../image/core/nestopia_ue/rgb.png)
![](../image/core/nestopia/rgb.png)

??? note "Palette - pal"
![](../image/core/nestopia_ue/pal.png)
![](../image/core/nestopia/pal.png)

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

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

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

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

??? note "Palette - raw"
![](../image/core/nestopia_ue/raw.png)
![](../image/core/nestopia/raw.png)

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

Expand All @@ -213,33 +215,33 @@ Settings with (Restart) means that core has to be closed for the new setting to
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.

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

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

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

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.

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

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

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

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.

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

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

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

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

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

## Controllers

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):
The Nestopia core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):

### User 1 - 4 device types

- None - Disables input.
- **Auto** - Automatically detects the device to use based on the internal database.
- Gamepad - Joypad
- 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)
- 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)
- 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)

### Multitap support

The Nestopia UE core uses the internal database to detect which games have multitap support.
The Nestopia core uses the internal database to detect which games have multitap support.

### Controller tables

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

## Compatibility

| Game | Issue |
|------------------------|----------------------------------------------------------------- |
| Skull & Crossbones | Graphical glitches and screen shaking when in 2-player mode. (1) |

??? note "(1)"
![](../image/core/nestopia_ue/skull.png)
The Nestopia core is compatible with 100% of officially released titles, and the vast majority of homebrew and hacks.

## External Links

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

### See also

Expand Down
2 changes: 1 addition & 1 deletion docs/library/quicknes.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,4 +228,4 @@ Settings with (Restart) means that core has to be closed for the new setting to
- [Nintendo - NES / Famicom (Emux NES)](emux_nes.md)
- [Nintendo - NES / Famicom (FCEUmm)](fceumm.md)
- [Nintendo - NES / Famicom (Mesen)](mesen.md)
- [Nintendo - NES / Famicom (Nestopia UE)](nestopia_ue.md)
- [Nintendo - NES / Famicom (Nestopia)](nestopia.md)
Loading

0 comments on commit 27f8905

Please sign in to comment.