NES / Famicom (Nestopia UE)Link

Contribute to this documentationLink

In order to propose improvements to this document, visit its corresponding source page on github. Changes are proposed using "Pull Requests."

There is a To-Do list for libretro/docs here

You can submit suggestions or issues regarding documentation at the libretro/docs issue tracker or in our forum thread.

BackgroundLink

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.

Why use this core?Link

Awaiting description.

How to get and install the Nestopia UE core:Link

  1. Start up RetroArch. Inside the main menu, go to 'Online Updater'.

  2. Just to make sure we have the latest info files, select 'Update Core Info FIles'. Wait until this is done. Then, select 'Core Updater'.

  3. Browse through the list and select 'NES / Famicom (Nestopia UE)'.

After this has finished downloading, the core should now be ready for use!

How to start (after installation):Link

  1. Go back to RetroArch's main menu screen. Select 'Load Content'.

  2. Browse to the folder that contains the content you want to run.

  3. Select the content that you want to run.

  4. If you are asked which core to select, choose 'NES / Famicom (Nestopia UE)'.

The content should now start running!

AuthorsLink

  • Martin Freij
  • R. Belmont
  • R. Danbrook

See alsoLink

LicenseLink

A summary of the licenses behind RetroArch and its cores have found here.

ExtensionsLink

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

  • nes
  • fds
  • unf
  • unif

DatabasesLink

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

BIOSLink

Required or optional firmware files go in RetroArch's system directory.

Warning

Nestopia UE requires the NstDatabase.xml for general proper emulation. Make sure it's in RetroArch's system directory.

Filename Description md5sum
NstDatabase.xml Nestopia UE Database file - Required
disksys.rom Family Computer Disk System BIOS - Required for Famicom Disk System emulation ca30b50f880eb660a320674ed365ef7a
custom.pal Custom NES Palette - Optional

FeaturesLink

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

Feature Supported
Restart
Screenshots
Saves
States
Rewind
Netplay
Core Options
RetroAchievements
RetroArch Cheats
Native Cheats
Controls
Remapping
Multi-Mouse
Rumble
Sensors
Camera
Location
Subsystem
Softpatching
Disk Control
Username
Language
Crop Overscan

DirectoriesLink

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

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

RetroArch's Save directory

  • 'content-name'.srm (Cartridge battery save)

RetroArch's State directory

  • 'content-name'.state# (State)

Geometry and timingLink

  • The Nestopia UE core's internal FPS is (FPS)
  • The Nestopia UE core's internal sample rate is (Rate)
  • The Nestopia UE core's core provided aspect ratio is (Ratio)

Custom color palettesLink

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.

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

Custom color palettes for the NES can be generated with either of these tools.

NstDatabase.xmlLink

It is HIGHLY RECOMMENDED you have NstDatabase.xml in RetroArch's system directory, you can get it from https://github.com/rdanbrook/nestopia

The Nestopia UE core relies on the NstDatabase.xml database file for

  • Games that support a custom mapper
  • Games that support multitap accessories
  • Games that support the Zapper
  • ROM Hacks
  • Famicom Disk System games
  • General proper emulation of games

Many games will have issues if NstDatabase.xml is not present in RetroArch's system directory.

Core optionsLink

The Nestopia UE 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.

  • Blargg NTSC filter (Off/composite/svideo/rgb/monochrome)

Enable Blargg NTSC filters.

Attention

These 'Blargg NTSC filter' core option screenshots have been taken with the 'Palette' core option set to cxa2025as.

Blargg NTSC filter - Off

Blargg NTSC filter - composite

Blargg NTSC filter - svideo

Blargg NTSC filter - rgb

Blargg NTSC filter - monochrome

  • Palette (cxa2025as/consumer/canonical/alternative/rgb/pal/composite-direct-fbx/pvm-style-d93-fbx/ntsc-hardware-fbx/nes-classic-fbx-fs/raw/custom)

Choose which color palette is going to be used.

Attention

These 'Palette' core option screenshots have been taken with the 'Blargg NTSC filter' core option set to Off.

Palette - cxa2025as

Palette - consumer

Palette - canonical

Palette - alternative

Palette - rgb

Palette - pal

Palette - composite-direct-fbx

Palette - pvm-style-d93-fbx

Palette - ntsc-hardware-fbx

Palette - nes-classic-fbx-fs

Palette - raw

  • Remove 8-sprites-per-scanline hardware limit (Off/On)

Self-explanatory.

  • CPU Speed (Overclock) (1x/2x)

Overclock the emulated CPU.

  • Automatically insert first FDS disk on reset (Off/On)

Self-explanatory.

  • Mask Overscan (Vertical) (Off/On)

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.

Mask Overscan (Vertical) - On

Mask Overscan (Vertical) - Off

  • Mask Overscan (Horizontal) (Off/On)

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.

Mask Overscan (Horizontal) - Off

Mask Overscan (Horizontal) - On

  • Preferred aspect ratio (auto/ntsc/pal/4:3)

Choose the preferred aspect ratio. RetroArch's aspect ratio must be set to Core provided in the Video seetings. 'auto' will use the NstDatabase.xml database file for aspect ratio autodetection. If there is no database present it will default to NTSC for 'auto'.

Preferred aspect ratio - ntsc

Preferred aspect ratio - pal

Preferred aspect ratio - 4:3

ratio_4by3

  • Game Genie Sound Distortion (Off/On)

Awaiting description.

  • Favored System (auto/ntsc/pal/famicom/dendy)

Choose which region the system is from. 'auto' will use the NstDatabase.xml database file for region autodetection. If there is no database present it will default to NTSC for 'auto'.

  • RAM Power-on State (0x00/0xFF/random)

Awaiting description.

  • Turbo Pulse Speed (2/3/4/5/6/7/8/9)

Set the turbo pulse speed for the Turbo B and Turbo A buttons.

ControllersLink

Device typesLink

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

User 1 - 4 device typesLink

  • None - Input disabled.
  • RetroPad - Joypad
  • RetroPad w/Analog - Joypad - There is no reason to switch to this.

Other controllersLink

Awaiting description.

Multitap supportLink

The Nestopia UE core relies on the NstDatabase.xml database file for multitap support.

Controller tablesLink

Joypad and analog device type tableLink

User 1 Input descriptors RetroPad Inputs
B
Turbo B
Select
Start
D-Pad Up
D-Pad Down
D-Pad Left
D-Pad Right
A
Turbo A
(FDS) Disk Side Change
(FDS) Eject Disk
(VSSystem) Coin 1
(VSSystem) Coin 2
(Famicom) Microphone
User 2 - 4 Input descriptors RetroPad Inputs
B
Turbo B
Select
Start
D-Pad Up
D-Pad Down
D-Pad Left
D-Pad Right
A
Turbo A
(FDS) Disk Side Change
(FDS) Eject Disk

Lightgun device type tableLink

User # Input descriptors RetroLightgun Inputs Zapper
N/A Gun Zapper Crosshair
N/A Gun Trigger Trigger
N/A Gun Turbo Light On

CompatibilityLink

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