This repository has been archived on 2022-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
Luma3DS-3GX/README.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2016-04-23 01:43:11 +02:00
# Luma3DS
*Noob-proof (N)3DS "Custom Firmware"*
2015-08-05 09:04:13 +02:00
### What it is
**Luma3DS** is a program to patch the system software of (New) Nintendo (2)3DS handheld consoles "on the fly", adding features such as per-game language settings, debugging capabilities for developers, and removing restrictions enforced by Nintendo such as the region lock.
2015-08-05 04:22:30 +02:00
2018-06-14 18:33:09 +02:00
It also allows you to run unauthorized ("homebrew") content by removing signature checks.
To use it, you will need a console capable of running homebrew software on the Arm9 processor. We recommend [Plailect's guide](https://3ds.hacks.guide/) for details on how to get your system ready.
2016-09-06 16:41:37 +02:00
Since v8.0, Luma3DS has its own in-game menu, triggerable by <kbd>L+Down+Select</kbd> (see the [release notes](https://github.com/LumaTeam/Luma3DS/releases/tag/v8.0)).
#
### Compiling
* Prerequisites
1. git
2. [makerom](https://github.com/jakcron/Project_CTR) in PATH
3. [firmtool](https://github.com/TuxSH/firmtool)
4. Up-to-date devkitARM+libctru
1. Clone the repository with `git clone https://github.com/LumaTeam/Luma3DS.git`
2. Run `make`.
2016-09-06 16:41:37 +02:00
The produced `boot.firm` is meant to be copied to the root of your SD card for usage with Boot9Strap.
2016-03-29 18:17:22 +02:00
#
### Setup / Usage / Features
See https://github.com/LumaTeam/Luma3DS/wiki
2015-08-05 12:45:22 +02:00
#
### Credits
See https://github.com/LumaTeam/Luma3DS/wiki/Credits
2016-04-24 20:12:58 +02:00
#
### Licensing
This software is licensed under the terms of the GPLv3. You can find a copy of the license in the LICENSE.txt file.
2018-06-14 18:33:09 +02:00
Files in the GDB stub are instead triple-licensed as MIT or "GPLv2 or any later version", in which case it's specified in the file header.