search

DS-Homebrew / TWiLightMenu

DSi Menu replacement for DS/DSi/3DS/2DS
https://wiki.ds-homebrew.com/twilightmenu/
GNU General Public License v3.0
3.15k stars 197 forks source link
nintendo-3ds nintendo-ds nintendo-dsi twilight-menu

readme


GBAtemp Thread Discord Server Build status on GitHub Actions Localized on Crowdin

TWiLight Menu++ is an open-source DSi Menu upgrade/replacement for the Nintendo DSi, the Nintendo 3DS, and Nintendo DS flashcards. It can launch Nintendo DS(i), SNES, NES, GameBoy (Color), GameBoy Advance, Sega GameGear/Master System, SG-1000/SC-3000 & Mega Drive/Genesis, Atari 2600/5200/7800/XEGS, MSX, Intellivision, Neo Geo Pocket, Sord M5, PC Engine/TurboGrafx-16, WonderSwan, and ColecoVision ROMs, as well as DSTWO plugins (if you use a DSTWO).

Compiling

Setting up

Compiling this app requires devkitPro's devkitARM, libnds, grit, and mmutil. These can be installed using devkitPro pacman with the following command:

sudo dkp-pacman -S nds-dev

(Note: Command will vary by OS, sudo may not be needed and it may be just pacman instead.)

Cloning

The repository contains submodules, so you need to clone recursively:

git clone --recursive https://github.com/DS-Homebrew/TWiLightMenu.git

If you cloned without pulling the submodules, you may update them afterwards:

git submodule update --init --recursive

Building

Once you have devkitPro's toolchains installed you can build the entirety of TWiLight Menu++ by simply running make package in the root of the repository. If you only want to build a specific part of TWiLight Menu++ you can cd to that folder and run make dist.

Once it finishes building, the output files will be in the 7zfile folder following the same directory structure as the official TWiLightMenu.7z builds.

Using Docker

Using the included Docker image, you can easily compile TWiLight Menu++ without having to manually set up the required version of devkitARM using the provided PowerShell (.ps1) scripts.

The script accepts make arguments as well. For example, .\compile_docker.ps1 clean will clean the directories of all the compiled code. If you would like to build all artifacts, run .\compile_docker.ps1 package.

Please note that Docker compilation is not compatible with native compilation on Windows. You should run .\compile_docker.ps1 clean to clean the artifacts before attempting to build with Docker. If a notification appears asking you to share your drive, you must choose to enable drive sharing for Docker to work on Windows.

Manual Pages

The manual pages are stored in a separate repository and downloaded from a release when building TWiLight Menu++. For more information, see the twilight-manual repository.

Subfolders

TWiLight Menu++ is composed of multiple "sub-projects" which all work together to create the DSi Menu replacement. Most subfolders in the repository contain their own code which will compile a xxx.nds file, which is generally copied to /_nds/TWiLightMenu/xxx.srldr inside the 7z file (or 7zfile folder).

Translating

You can help translate TWiLight Menu++ on the Crowdin project. If you'd like to request a new language be added then please ask on the Discord server.

Credits

Main Developers