melonDS
-------
melonDS is an emulator for the Nintendo DS and DSi. The Jolly Good API port is
designed for use with content for the Nintendo DS.

Source for the emulator core is unmodified from upstream sources.

This repository lives at https://gitlab.com/jgemu/melonds

Compiling
---------
Make sure you have The Jolly Good API's header files installed. If you did
not install them, you will be required to include their path in CXXFLAGS.

GNU Make's default behaviour for compiling C++ sources is to use g++. If your
platform of choice uses an unpatched GNU Make, you will need to override the
CXX implicit variable if you wish to use a different compiler.

Options:
  DISABLE_MODULE - Set to a non-zero value to disable building the module.
  ENABLE_STATIC_JG - Set to a non-zero value to build a static JG archive.

Linux:
  make

macOS:
  make

BSD:
  gmake

Windows (MSYS2):
  make

Cross Compile:
(For example compiling on Linux for MinGW)
  AR=x86_64-w64-mingw32-ar \
  CC=x86_64-w64-mingw32-cc \
  CXX=x86_64-w64-mingw32-c++ \
  PKG_CONFIG=x86_64-w64-mingw32-pkg-config \
  STRIP=x86_64-w64-mingw32-strip \
  make

The build will be output to "melonds/". This directory may be used as is
locally by copying it to your local "cores" directory, or may be installed
system-wide using the "install" target specified in the Makefile.

Settings
--------
screen_layout = 0
0 = Vertical, 1 = Horizontal, 2 = One Screen, 3 = Fibonacci (Left),
4 = Fibonacci (Right)

screen_swap = 0
0 = Disable, 1 = Enable

threaded_rendering = 1
0 = Disable, 1 = Enable

external_firmware = 0
0 = Disable, 1 = Enable

Notes
-----
In most cases, FreeBIOS is sufficient, but for cases where it is not, using an
external firmware image alongside ARM7 and ARM9 BIOS images is supported. All
three must be present in the BIOS directory, using the filenames "firmware.bin",
"bios7.bin", and "bios9.bin". Saving changes to firmware results in a
"firmware.nv" being added to your save directory to avoid overwriting data in
your original dump.

A number of screen layouts are supported, and the ability to quickly swap
which screen is the main or primary screen is available via a button definition.
When using Fibonacci layouts, use the small version of the touchscreen to input
touch data. When using One Screen mode, make sure the touchscreen is visible
to input touch data.

Copyright
---------
melonDS Jolly Good API Port (GPL-3.0-or-later)
  Copyright (c) 2022-2026 Rupert Carmichael
