melonds-ds/README.md

melonDS DS

An enhanced remake of the melonDS core for libretro that prioritizes standalone parity, reliability, and usability.

Getting melonDS DS

At the moment, melonDS DS does not have a stable release. I intend to set up a process for those soon. Once melonDS DS matches all the features provided by the legacy melonDS core, I will submit it for inclusion in the official RetroArch distribution.

In the meantime, I suggest building melonDS DS from source or downloading one of the raw build artifacts.

Installation

Installation instructions may vary depending on your chosen libretro frontend.

RetroArch

Here's how you can install melonDS DS in RetroArch:

1. Place melondsds_libretro.dll (or .so or .dylib, depending on the platform) in RetroArch's cores directory.
2. Place melondsds_libretro.info in the same directory as the other .info files, which is usually cores or info depending on the platform.

Using melonDS DS

Usage instructions may vary depending on your chosen libretro frontend.

RetroArch

Playing Nintendo DS Games

1. Start RetroArch.
2. Scan your Nintendo DS game library with the Import Content menu to build a playlist if you haven't already.
3. Load a Nintendo DS game from the playlist. If you have the legacy melonDS core installed, you may need to select melonDS DS explicitly.

Important

If you have ROM hacks or homebrew, you may need to manually add them to the playlist with the Manual Scan submenu.

Installing Nintendo DS BIOS

melonDS includes built-in BIOS and firmware replacements that work with most games. However, some features require original Nintendo DS or DSi BIOS system files:

• Game Boy Advance connectivity requires native Nintendo DS BIOS and firmware.
• DSi mode requires native Nintendo DS and DSi BIOS, firmware, and NAND files.

You can place your system files in RetroArch's system directory or in a subdirectory named melonDS DS. Name the system files as follows:

• DS ARM7 BIOS: bios7.bin
• DS ARM9 BIOS: bios9.bin
• DS Firmware: Anything, pick an image in the core options
• DSi ARM7 BIOS: dsi_bios7.bin
• DSi ARM9 BIOS: dsi_bios9.bin
• DSi Firmware: Anything, pick an image in the core options
• DSi System NAND: Anything, pick an image in the core options

Game Boy Advance Connectivity

Important

melonDS (and therefore melonDS DS) only supports GBA connectivity with native NDS BIOS and firmware files.

The steps for loading a Game Boy Advance ROM are a little more involved.

1. Install the Nintendo DS BIOS and firmware as described above.
2. Load the melonDS DS core using the Load Core menu.
3. Enter the Subsystems menu and select Load Slot 1 & 2 Boot.
4. Select a Nintendo DS ROM, a Game Boy Advance ROM, and optionally a Game Boy Advance save file (in that order).
5. Start the game.

This combination of ROMs will appear in your History playlist, so you won't have to repeat this process every time you want to play.

Note

melonDS can load Game Boy Advance ROMs and save data for the purpose of Slot-2 connectivity, but it cannot actually play GBA games. Use a GBA core instead.

New Features

Enhancements over the legacy melonDS core include:

Standalone Parity

Unlike most other libretro cores, melonDS DS is not a fork of an existing code base. It uses standalone melonDS as a statically-linked dependency, which means that large changes and merge conflicts are less of an issue. As a result, improvements to standalone melonDS are much easier to integrate!

Wi-Fi Support

Wi-Fi is fully emulated on all platforms!

For your convenience, you can choose from one of several preconfigured servers in the core options menu, with Kaeru WFC being the default.

Future versions of melonDS DS will allow you to specify arbitrary servers. In the meantime, you can set the appropriate DNS address from within the emulated console's Wi-Fi settings menu.

Note

Do not confuse this with local multiplayer. melonDS DS does not support emulating local wireless at this time.

Homebrew Save Data

The legacy core does not support save data for homebrew games. However, melonDS DS does!

melonDS DS looks in the system/melonDS DS directory (i.e. alongside the BIOS files) for a homebrew SD card image named dldi_sd_card.bin. If one doesn't exist, a virtual 4GB SD card will be created if necessary. See the core options for more information.

Note

melonDS DS does not support savestates for homebrew games.

Microphone Support

melonDS DS supports libretro's new microphone API, allowing you to use your device's microphone for Nintendo DS games!

Note

This feature requires support from the frontend. The latest stable release of RetroArch includes microphone support on several platforms.

Screen Rotation

melonDS DS fully supports rotating the emulated DS left, right, and upside-down! Now you can play games that were meant to be played sideways, such as Brain Age.

Enhanced Screen Layout Options

The legacy melonDS core supports multiple screen layouts, but they can only be switched out through the core options menu. This is inconvenient for games that use different layouts.

melonDS DS allows you to cycle through up to 8 screen layouts (including rotations) at the push of a button!

Streamlined DSiWare Installation

melonDS does not support direct-booting DSiWare at this time; you need to install DSiWare games to a NAND image, then start them from the DSi menu when you want to play.

But melonDS DS streamlines this process!

• When you select a DSiWare ROM, it's temporarily installed on the NAND and removed when you exit the core.
• Title metadata is automatically downloaded from Nintendo's servers and cached locally for later.
• When a DSi game is loaded, the DSi menu will boot with the temp-installed game selected.

Other Niceties

• Battery Support: melonDS DS uses libretro's new power state API to reflect your device's power status (battery level, charging status, etc.) in the emulated console! Requires support by the frontend.
• Selectable NAND and Firmware Images: You don't need to hard-code a specific name for your firmware or NAND images! Just place them in system/melonDS DS (or local equivalent) and pick them from the core options.

Missing Features

These features have not yet been implemented in standalone melonDS, or they haven't been integrated into melonDS DS. If you want to see them, you should contribute to the upstream project!

• Local Wireless: Upstream melonDS supports emulating local wireless multiplayer (e.g. Multi-Card Play, Download Play) with multiple instances of melonDS on the same computer. However, melonDS DS does not support this functionality at this time.
• Homebrew Savestates: melonDS has limited support for taking savestates of homebrew games, as the virtual SD card is not included in savestate data.
• DSi Savestates: Nintendo DSi mode does not support savestates. This implies that rewinding and runahead are not supported in DSi mode.
• DSi Direct Boot: Direct Boot does not support DSiWare games at this time. They must be installed on a NAND image, and they must be started from the DSi menu.
• Game Boy Advance Emulation: melonDS can load Game Boy Advance ROMs and save data for use by compatible Nintendo DS games, but it cannot actually emulate the GBA. GBA emulation is not within the scope of melonDS; use a GBA emulator instead.
• Threaded Software Renderer: melonDS supports offloading its software renderer to a separate thread, but rewinding while using it can crash RetroArch. This was holding up the initial release, so the threaded renderer is disabled until this bug is fixed.
• Slot-2 Accessories: The only Slot-2 accessories that melonDS currently supports are the solar sensor and Memory Expansion Pak. However, melonDS DS does not yet support these devices.
• GDB Stub Support: melonDS recently gained support for debugging emulated DS games with GDB. This is a low priority for melonDS DS, since libretro frontends are typically used for playing games. However, I may integrate it if there's enough demand.

Compatibility

Games

melonDS DS is compatible with all games that melonDS supports, unless otherwise noted in the Missing Features section. If this is not the case, please report it.

Libretro Frontends

melonDS DS primarily targets RetroArch, but you may be able to use it with other libretro frontends. If you encounter problems using this core with other frontends, please report them! Support is not guaranteed, but I'll do the best I can.

Building

MelonDS DS is built with CMake.

Dependencies

You will need to install the following beforehand:

• CMake 3.19 or later
• Git
• A C++20 compiler (MSVC is not supported)

Most other dependencies are fetched automatically by CMake.

Windows

1. Install MSYS2.

2. Open the MSYS2 MinGW 64-bit terminal from the Start Menu.

3. Install dependencies like so:

   pacman -Syu # update the package database
   pacman -S git mingw-w64-x86_64-{cmake,toolchain} # install dependencies
   

4. Proceed to Compilation. You may need to remain in the MSYS2 terminal.

macOS

1. Install Homebrew.

2. Install dependencies like so:

   brew install cmake git pkg-config cmake
   

3. Install Xcode and the Xcode command-line tools.

4. Proceed to Compilation.

Note

macOS builds exclude OpenGL by default, as the OpenGL renderer doesn't currently work on the platform. To enable it anyway, pass -DENABLE_OPENGL=ON to CMake.

Linux

1. Install dependencies like so:

   sudo apt install cmake git pkg-config # Ubuntu/Debian
   sudo pacman -S base-devel cmake extra-cmake-modules git # Arch Linux
   

2. Proceed to Compilation.

Android

1. Install the Android SDK and NDK. The simplest way to do this is through Android Studio.
2. Proceed to Compilation.

iOS

These steps can only be done on macOS.

1. Install Xcode and the Xcode command-line tools.
2. Proceed to Compilation.

Compilation

Once you've installed the dependencies, the process for building melonDS DS is mostly the same on all platforms:

git clone https://github.com/JesseTG/melonds-ds
cd melonds-ds
cmake -B build # Generate the build system, and add any -D or --toolchain flags here
cmake --build build # Build the project

CMake Variables

These are some of the most important CMake variables that can be used to configure the build. To see the rest, run cmake -LH in the build directory.

Variable	Description
ENABLE_OPENGL	Whether to build the OpenGL renderer. Defaults to ON on Windows and Linux, OFF on other platforms.
ENABLE_THREADED_RENDERER	Enables the multithreaded software renderer. Crashes when rewinding in RetroArch, so it's not generally available yet.
MELONDS_REPOSITORY_URL	The Git repo from which melonDS will be cloned. Set this to use a fork.
MELONDS_REPOSITORY_TAG	The melonDS commit to use in the build.
LIBRETRO_COMMON_REPOSITORY_URL	The Git repo from which libretro-common will be cloned. Set this to use a fork.
LIBRETRO_COMMON_REPOSITORY_TAG	The libretro-common commit to use in the build.

See here for more information about the standard variables that CMake defines; these can also be used to customize the build.

About the Name

Various games received enhanced remakes or ports to the Nintendo DS, including such gems as:

• Super Mario 64 DS
• Ridge Racer DS
• Brothers in Arms DS
• Mega Man Battle Network 5: Double Team DS
• Diddy Kong Racing DS

What do these games have in common? They're all remakes or enhanced ports with a suffix of "DS"!

I see this core as an enhanced remake of the legacy melonDS core, so I wanted to embody that in the name.

Special Thanks

• The melonDS team for making a great emulator and for their help on Discord.
• The libretro team for making a great app, for their help on Discord, and for fixing bugs in RetroArch that affected melonDS DS.
• Everyone who's ever reported a bug, for their role in ensuring a polished product.
• Nintendo, for all the memories.

Disclaimers

This project is not affiliated with, developed by, or endorsed by the melonDS team or by Nintendo.