Guide_3DS/docs/index.md
lifehackerhansol d84cb07e29
docs: port to VitePress
Things that happen in this shameless squash:
- Removed 404 page
  - It doesn't work in VitePress and making it work in VitePress needs
    some invasive hack in the theme that I'm not willing to do
  - The default is more than enough, though
- Moved consoleVersionSelect include to another directory
  - This avoids being uploaded to Crowdin for translation
- Inline all SafeB9SInstaller includes
  - Not only do parameterized includes not work, but if/else statements
    don't work at all
- The sysupdate include parameter hasn't been used since MSET9, so it
  actually works just fine without any parameters. Hooray(?)
- Move mset9-chorus to an include, that logic doesn't work in VitePress
- Removed Get Started button from homepage, it breaks translations
- Tables in get-started are now shown by default; it seems VitePress really does
  not want us to use inline script. So we cannot enable it upon
  realizing that the browser is JS capable
- Include parameters are now in frontmatter to allow translation
- Hacked in a bunch of CSS values kanged from the old theme to make it
  look not stupid
- Drop headers down one level to make table of contents work
2024-09-27 08:38:29 -07:00

52 lines
1.8 KiB
Markdown

---
layout: home
title: "3DS Hacks Guide"
hero:
text: "3DS Hacks Guide"
tagline: "A complete guide to 3DS (and 2DS) custom firmware, from stock to boot9strap."
image:
src: /images/home-page-feature.jpg
---
::: info
Thoroughly read all of the introductory pages (including this one!) before proceeding.
:::
::: danger
<!--@include: ./_include/3ds-online.md -->
:::
## What is custom firmware?
**Custom firmware** ("CFW") is a full software modification to your 3DS, comparable to "administrator access" on a computer. It allows you to do anything that the 3DS is physically capable of doing, rather than being limited by whatever Nintendo allows you to do.
Popular uses for custom firmware include:
* Running homebrew software and games made for or ported to the Nintendo 3DS
* Bypassing the region lock, allowing you to play games from other regions
* HOME Menu customization, using community-created [themes and badges](https://themeplaza.art)
* Modification of games ("ROM hacks") through [LayeredFS](https://github.com/knight-ryu12/godmode9-layeredfs-usage/wiki/Using-Luma3DS'-layeredfs-(Only-version-8.0-and-higher))
* Save data editing, backup, and restore
* Emulation of older consoles, as well as native playback of DS and GBA games
* Installing your physical cartridges for digital use
## What does this guide install?
This guide will:
+ Install **boot9strap** and **Luma3DS custom firmware** on unmodified retail 3DS/2DS consoles
+ Luma3DS will automatically remove the region lock and allow you to run unsigned software
+ Install various pieces of homebrew software, such as a package installer, save file manager, and a homebrew app store
+ Make critical system file backups that can help avoid bricks (and recover data in the event of one)
___
::: tip
Continue to [Key Information](key-information)
:::