From 91b59112dcfc6960d3f8799958984d7d6d6270b9 Mon Sep 17 00:00:00 2001 From: Valentin PONS Date: Sat, 19 Mar 2022 13:17:11 +0100 Subject: [PATCH] Updated repository info --- README.md | 51 ++++++++++++++++++++++++--------------------------- 1 file changed, 24 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ee59bfe72..dd6862556 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,33 @@ -# Luma3DS -*Noob-proof (N)3DS "Custom Firmware"* +# Luma3DS with Timelock -### 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. +This modified build (available on the `timelock` branch) contains a Timelock system. +It enables Rosalina (Luma3DS's custom sysmodule) to lock the console after a certain time with a PIN code. +Something which is missing from the original parental control, in my opinion. +The main use is for parents not wanting their kids to use the console for too long. -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. +It provides a new config menu in Rosalina letting the user handle the following options: +- Enabling/Disabling the timelock system +- Set the time limit +- Set the PIN code -Since v8.0, Luma3DS has its own in-game menu, triggerable by L+Down+Select (see the [release notes](https://github.com/LumaTeam/Luma3DS/releases/tag/v8.0)). +It uses a config file storing the properties listed above, as well as an elapsed time value to keep track of the time spent using the console. This lets us keep track of the usage time even after a reboot. -# -### 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`. +**Default PIN: 0000** - The produced `boot.firm` is meant to be copied to the root of your SD card for usage with Boot9Strap. -# -### Setup / Usage / Features -See https://github.com/LumaTeam/Luma3DS/wiki +Here are some screenshots: -# -### Credits -See https://github.com/LumaTeam/Luma3DS/wiki/Credits +1. Rosalina menu +![1-RosalinaMenu](https://user-images.githubusercontent.com/1681898/159120680-ad2e813b-1337-4744-afab-d9f224620058.jpg) -# -### Licensing -This software is licensed under the terms of the GPLv3. You can find a copy of the license in the LICENSE.txt file. +2. Locked timelock menu +![2-LockedTimelockMenu](https://user-images.githubusercontent.com/1681898/159120683-0a4eccdb-2af9-48a7-95f1-362e3be3ce1c.jpg) -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. +3. Unlocking timelock menu +![3-UnlockingTimelockMenu](https://user-images.githubusercontent.com/1681898/159120687-010fb016-0e05-4bc2-895a-e37400cc0428.jpg) + +4. Unlocked timelock menu +![4-UnlockedTimelockMenu](https://user-images.githubusercontent.com/1681898/159120691-b2a78805-6dab-4ad9-9ca5-4b6b4e0f82ba.jpg) + +5. Timelocked console +![5-Timelocked](https://user-images.githubusercontent.com/1681898/159120695-cddaba00-8644-4d8c-876a-02518a878cba.jpg)