UNES is an emulator plug-in that runs Nintendo Entertainment System Nintendo FC Game *.nes files in the Unity environment. The project is based on Emulator.NES to achieve cross-platform through Unity.

[中文文档]

• 1. Start
• 2. Load
  • 2.1. Resources loading
  • 2.2. FileStream loading
• 3. Configuration
  • 3.1. Filter Mode
  • 3.2. Logic Thread
  • 3.3. Input Config
• 4. input
• 5. API
  • 5.1. Boot
  • 5.2. Save
  • 5.3. Load
• 6. Mapper
• 7. Problem

• 1. Create a new or select a GameObject in the scene and add the UNESBehaviour component.
• 2. Create a new RenderTexture to render the game screen.
• 3. Use any way you want to display the RenderTexture file in the game.
• 4. Use the default input method or realize custom input on demand.
• 5. Implement the loading of *.nes files on demand to obtain byte[] format data.
• 6. Call the UNESBehaviour.Boot(byte[] romData) interface to start the game.

If you need to use the Resources.Load() interface to load the ROM file, you need to pay attention to changing the .nes extension to .bytes, and then use the following method to load:

var bytes = Resources.Load<TextAsset>(romPath).bytes;
UNES.BootRom(bytes);

If you use the method of loading the original file byte stream, you can directly call the UNESBehaviour.Boot(byte[] romData) interface.

Filter mode of game screen rendering:

For detailed explanation, please refer to FilterMode

If the Logic Thread option is turned on, the simulation calculations of the CPU and PPU parts will be executed by other thread, and the Unity main thread is only responsible for reading the status data to refresh the game screen, which can significantly increase the number of frames.

Customize the physical keyboard keys corresponding to the native keys.

Default configuration control method:

Obtain the byte array format of the original ROM file in any way for the emulator to start:

public void Boot(byte[] romData);

The simulator itself only provides the data of the current running state, and does not provide the persistence implementation of the data file. Need to realize the preservation of archived data by oneself.

public byte[] GetSaveData();

Obtain archive file data in any way for the emulator to restore game progress:

public void LoadSaveData(byte[] saveData);

There are many Mapper extension formats in NES, and the implemented part of the project implementation can theoretically support most common games.

• Audio APU simulation is not implemented.
• Only realize Unity basic input system and pure keyboard operation mode.
• Not all Mappers are implemented.
• The performance of the PPU simulation part is low, and the frame number is unstable on the low-end mobile devices.