Luma3DS-3GX/README.md

# Luma3DS
*Noob-proof (N)3DS "Custom Firmware"*

## What it is

**Luma3DS** is a program to patch the system software of (New) Nintendo 3DS handheld consoles "on the fly", adding features (such as per-game language settings and debugging capabilities for developers) and removing restrictions enforced by Nintendo (such as the region lock).
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.

Since Luma3DS v8.0, Luma3DS has its own in-game menu, triggerable by `L+Down+Select` (see the [release notes](https://github.com/AuroraWright/Luma3DS/releases/tag/v8.0)).

---

## Compiling

First you need to clone the repository with: `git clone https://github.com/AuroraWright/Luma3DS.git`
To compile, you'll need [armips](https://github.com/Kingcom/armips) and a build of a recent commit of [makerom](https://github.com/profi200/Project_CTR) added to your PATH. You'll also need to install [firmtool](https://github.com/TuxSH/firmtool), its README contains installation instructions.
You'll also need to update your [libctru](https://github.com/smealum/ctrulib) install, building from the latest commit.
Here are [Windows](https://buildbot.orphis.net/armips/) and [Linux](https://ev1l0rd.s-ul.eu/mEIk4atQ) builds of armips (thanks to who compiled them!).
Run `make` and everything should work!
You can find the compiled files in the `out` folder.

---

## Setup / Usage / Features

See https://github.com/AuroraWright/Luma3DS/wiki

---

## Credits

See https://github.com/AuroraWright/Luma3DS/wiki/Credits

---

## Licensing

This software is licensed under the terms of the GPLv3.
You can find a copy of the license in the LICENSE.txt file.

You can also use all of `sysmodules/rosalina/include/gdb/`, all of `sysmodules/rosalina/source/gdb/`, `sysmodules/rosalina/include/gdb.h`, `sysmodules/rosalina/source/gdb.c`, `sysmodules/rosalina/include/sock_util.h` and `sysmodules/rosalina/source/sock_util.c` under the terms of the GPLv2, as an option. If you choose to do so, you needn't include the GPLv3 notices that are present in the beginning of each of these files.
Welcome Luma3DS 2016-04-23 01:43:11 +02:00			`# Luma3DS`
			`Noob-proof (N)3DS "Custom Firmware"`
git stuff 2015-08-05 09:04:13 +02:00
Update readme 2016-09-06 16:41:37 +02:00			`## What it is`
readme 2015-08-05 04:22:30 +02:00
Update readme 2016-09-06 16:41:37 +02:00			`Luma3DS is a program to patch the system software of (New) Nintendo 3DS handheld consoles "on the fly", adding features (such as per-game language settings and debugging capabilities for developers) and removing restrictions enforced by Nintendo (such as the region lock).`
Double-license the gdbstub. 2018-06-14 18:33:09 +02:00			`It also allows you to run unauthorized ("homebrew") content by removing signature checks.`
Update links to the Plailect's Guide 2018-03-31 16:29:25 +02:00			`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.`
Update readme 2016-09-06 16:41:37 +02:00
Reference release notes in README.md 2017-06-05 16:15:49 +02:00			Since Luma3DS v8.0, Luma3DS has its own in-game menu, triggerable by `L+Down+Select` (see the [release notes](https://github.com/AuroraWright/Luma3DS/releases/tag/v8.0)).
Added Rosalina, see details - see release notes - ( ͡° ͜ʖ ͡°)( ͡° ͜ʖ ͡°)( ͡° ͜ʖ ͡°) - (∩ ͡° ͜ʖ ͡°)⊃━☆ﾟ - ( ͡ᵔ ͜ʖ ͡ᵔ) ♫┌( ͡° ͜ʖ ͡°)┘♪ ♫└( ͡° ͜ʖ ͡°)┐♪ 2017-06-05 02:02:04 +02:00
Update readme 2016-09-06 16:41:37 +02:00			`---`

			`## Compiling`

Double-license the gdbstub. 2018-06-14 18:33:09 +02:00			First you need to clone the repository with: `git clone https://github.com/AuroraWright/Luma3DS.git`
Update README.md w/r/t firmtool 2017-05-23 17:41:19 +02:00			`To compile, you'll need [armips](https://github.com/Kingcom/armips) and a build of a recent commit of [makerom](https://github.com/profi200/Project_CTR) added to your PATH. You'll also need to install [firmtool](https://github.com/TuxSH/firmtool), its README contains installation instructions.`
Double-license the gdbstub. 2018-06-14 18:33:09 +02:00			`You'll also need to update your [libctru](https://github.com/smealum/ctrulib) install, building from the latest commit.`
Remove AUR package from prebuilds. Ater discussion with @Hikari-chin (and some other people), I've come to the conclusion that it's not a wise idea to link to an AUR package in the README. That said, it might still be useful to provide a compiled version of armips for Linux as Windows builds are also provided. To this extent I've compiled armips for both x86 and x86_64 architectures (available in the zip file linked in the commit, or [here](https://ev1l0rd.s-ul.eu/mEIk4atQ) if you dont wish to open the commit). (It's possible to identify the binary arch with the `file` command if one wishes to verify I did this properly). 2018-05-22 20:18:39 +02:00			`Here are [Windows](https://buildbot.orphis.net/armips/) and [Linux](https://ev1l0rd.s-ul.eu/mEIk4atQ) builds of armips (thanks to who compiled them!).`
Double-license the gdbstub. 2018-06-14 18:33:09 +02:00			Run `make` and everything should work!
Update readme 2016-09-06 16:41:37 +02:00			You can find the compiled files in the `out` folder.

			`---`
fix 2015-08-05 04:30:38 +02:00
Update readme 2016-09-06 16:41:37 +02:00			`## Setup / Usage / Features`
Updated readME 2016-03-29 18:17:22 +02:00
Welcome Luma3DS 2016-04-23 01:43:11 +02:00			`See https://github.com/AuroraWright/Luma3DS/wiki`
README 2015-08-05 12:45:22 +02:00
Update readme 2016-09-06 16:41:37 +02:00			`---`

			`## Credits`

Update ReadME 2016-04-24 20:12:58 +02:00			`See https://github.com/AuroraWright/Luma3DS/wiki/Credits`

Update readme 2016-09-06 16:41:37 +02:00			`---`

			`## Licensing`
Update ReadME 2016-04-24 20:12:58 +02:00
Double-license the gdbstub. 2018-06-14 18:33:09 +02:00			`This software is licensed under the terms of the GPLv3.`
Update README.md 2016-05-06 17:18:01 +02:00			`You can find a copy of the license in the LICENSE.txt file.`
Double-license the gdbstub. 2018-06-14 18:33:09 +02:00
			You can also use all of `sysmodules/rosalina/include/gdb/`, all of `sysmodules/rosalina/source/gdb/`, `sysmodules/rosalina/include/gdb.h`, `sysmodules/rosalina/source/gdb.c`, `sysmodules/rosalina/include/sock_util.h` and `sysmodules/rosalina/source/sock_util.c` under the terms of the GPLv2, as an option. If you choose to do so, you needn't include the GPLv3 notices that are present in the beginning of each of these files.