Skip to content

Instantly share code, notes, and snippets.

@PixelSergey
Last active March 24, 2024 18:19
Show Gist options
  • Star 11 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save PixelSergey/5dbb4a9b90d290736353fa58e4fcbb42 to your computer and use it in GitHub Desktop.
Save PixelSergey/5dbb4a9b90d290736353fa58e4fcbb42 to your computer and use it in GitHub Desktop.
LayeredFS patching guide

Luma LayeredFS game patching guide

This is a guide for patching a game with Luma's built-in LayeredFS feature. This requires the latest Luma3DS and b9s. They can be installed using the guide if you have not already.


Dumping RomFS from a game

You can dump RomFS from any game using Godmode9. The RomFS can be used with some patchers or for exploring and modifying the game files yourself. A detailed tutorial on dumping RomFS from games can be found here.


Enabling Luma LayeredFS game patching

  1. Power off your console
  2. Boot your console while holding (Select) to launch the Luma configuration menu
  3. Use the (A) button and the D-Pad to turn on the following:
  • “Enable game patching”
  • In some cases it may already be enabled. If so, proceed to the next step  
  • For a full list of features that this setting enables, see Luma3DS' wiki
  1. Press (Start) to save and reboot

Applying patches

Patches that work with LayeredFS come as folders (or .zip archives) with the modified romFS files in them.

  1. Unzip the patch archive, if applicable
  2. Place the patch's files into the /luma/titles/<titleID>folder on your SD card
  • Game titleIDs are 16 characters long and start with 00040000
  • You can find the titleID of your game from the 3dsdb title database
  • If your patch already comes inside a folder with the titleID, put that folder into the /luma/titles folder and not into another folder
  1. Launch your game from the HOME menu and the patch should activate
  • If the game acts normal, make sure that you have enabled game patching and that the patch folder is correcrly placed
  • If you get an arm11 exception, make sure that none of the patch files are corrupt
@BigWut
Copy link

BigWut commented Oct 28, 2020

does this work with cartridges?

@PixelSergey
Copy link
Author

does this work with cartridges?

Yes, it does! The process is identical.

@Tari-Bluejay9
Copy link

I don't have a titles folder in the luma folder what do I do?

@BigWut
Copy link

BigWut commented Nov 4, 2020

I just had to make a new one with the correct Id as its title.

@PixelSergey
Copy link
Author

I don't have a titles folder in the luma folder what do I do?

Just make it. Make sure it's named titles

@ramdompersom
Copy link

This works with dlcs?

@PixelSergey
Copy link
Author

This works with dlcs?

It should. Just make sure you have the right TitleID for the DLC you want to patch.
DLC TitleIDs start with the numbers 0004008c.

@Hareon
Copy link

Hareon commented Apr 2, 2021

Can I patch a Manual.bcma? I tried to replace one for another and nothing happened. I created a folder named Manual (from ExtractedManual) and I placed the Manual.bcma there.

@PixelSergey
Copy link
Author

Can I patch a Manual.bcma? I tried to replace one for another and nothing happened. I created a folder named Manual (from ExtractedManual) and I placed the Manual.bcma there.

No, unfortunately this is impossible. LayeredFS patches a running title, like a game; manuals run alongside games (just like the 3DS notes applet) and cannot be LayeredFS patched.
Fan translations such as the Dai Gyakuten Saiban translation by Scarlet Study make their own "fake" game update that the console recognises. This can patch a manual (and translate it to English, in their case).

@BenjaminTheHedgefox
Copy link

For some reason SaltySD stopped any Miitopia mods from working, what is the fix?

@PixelSergey
Copy link
Author

For some reason SaltySD stopped any Miitopia mods from working, what is the fix?

No clue. Are you sure SaltySD is the cause? What happens if you remove SaltySD?

@AlgebraManiacABC
Copy link

I have been attempting to edit the music for Ace Attorneys Trilogy (id 00138f00) for ages to no avail. I've placed everything correctly but the music doesn't change.

Yes, I am using the right format; All I did was copy a single track (BGM000) and use it to replace all other tracks (Mostly for testing).

@Salopa1359
Copy link

Is it possible to switch between patches for a single game without having to move files on the sd card?

@unkownpit
Copy link

I have installed the latest version of hombrew on my 2ds, but no icon for a launcher is showing up.
I don't remember where I found the instructions, but they say that the L and r buttons are supposed to set up a launcher, or something.
but, my l button is broken. is there any way to actually install a launcher without the L button?

@PixelSergey
Copy link
Author

I have installed the latest version of hombrew on my 2ds, but no icon for a launcher is showing up. I don't remember where I found the instructions, but they say that the L and r buttons are supposed to set up a launcher, or something. but, my l button is broken. is there any way to actually install a launcher without the L button?

Yes, it is. Generate and download a config file from this website (change the Luma menu combination where it says "Rosalina menu") and replace the config file on your SD card.
https://3ds.eiphax.tech/config

@LateusBetelgeuse
Copy link

It is possible to patch a running DS game? I want to test some FFTA2 and PKMN-SS mods I've been working on, and this seems ideal for rapid testing.

@PixelSergey
Copy link
Author

PixelSergey commented Mar 12, 2023

It is possible to patch a running DS game? I want to test some FFTA2 and PKMN-SS mods I've been working on, and this seems ideal for rapid testing.

No.
NDS games run in NDS mode. They cannot be patched with LayeredFS as they do not have TitleIDs like 3DS games and apps do.
Your best shot would probably be to buy a flashcart (not sure how well rapid testing would work with them, but they do have support for cheats). An alternative you could look into is TWiLightMenu++, but I am not sure how cheats work with it, either. I think just a PC emulator might work best if you're developing the mods on a PC.

@plumberdude
Copy link

Should the file be in the root of the sd card or should it be in another specific folder? There are no title id folders or anything on my card

@PixelSergey
Copy link
Author

Should the file be in the root of the sd card or should it be in another specific folder? There are no title id folders or anything on my card

Put your patch inside the /luma/titles folder on your SD card (the luma folder is on the root of the SD).
It is okay if you have no other TitleID files right now, just put the files there and create the folders if you need.
Your SD card should then have the folder /luma/titles/TITLEID, where TITLEID is a 16-digit number.

@DiamondSquidAmy
Copy link

What do I do if I have the game downloaded, and as a cartridge?

@adamsousa
Copy link

adamsousa commented Aug 6, 2023

Is it possible to change the home screen banner? Tried doing it myself but didn't have any luck. Created a "banner" folder in luma/titles/title_id

@PixelSergey
Copy link
Author

Is it possible to change the home screen banner? Tried doing it myself but didn't have any luck. Created a "banner" folder in luma/titles/title_id

Unfortunately not. The home screen banner is handled by a completely different system and cannot be patched by LayeredFS.

Scarlet Study, who made a fan translation of Dai Gyakuten Saiban (now The Great Ace Attorney) bypassed this problem by creating an update cia for the game that could patch the home screen banner. I don't know how it works, look on their page / ask them / google for more details :)

@PixelSergey
Copy link
Author

What do I do if I have the game downloaded, and as a cartridge?

It will work. Both will be patched, since games released on both cartridge and eShop have the same titleID.

@adamsousa
Copy link

@PixelSergey Thanks for the info!

@Nala1987
Copy link

I just ordered a used cartridge version of omega ruby, will I be able to patch it with rising ruby? I had alpha sapphire patched with sinking sapphire but it would keep crashing and I accidentally deleted it so I ordered omega ruby.

@ghostcitytrafficjam
Copy link

Hi! This was super useful. I do have a bit of an issue, though...
I understand what I'm supposed to do, but I'm stuck at placing the patches files into the folder with the title id.
First of all, I didn't have a 'titles' folder under luma, so I simply made one, as people said to do in the comments. However, the mod I'm installing (Story of Seasons Trio of Towns: True Love Edition) says I should place the patch with the 1.1 update title id, rather than the game's. I'm unsure whether I need to make a folder for the actual game's title id along with one for the update, just put the patch with the game's title id, or leave the game's title id out and just do the update id.

Second of all, I know this is likely more of a personal issue rather than an issue others can help with, but no matter what I do, I can't extract the patch files from the zip folder. I get an error saying that it "couldn't find the specified path." It won't let me move the file to a new folder, copy and paste it, or simply unzip the whole thing.
I know this is an older post, but any insight would be a huge help.

@IsaiahFisher19
Copy link

My cousin and I are trying to play a Pokemon X and y randomizer I got X working for me on my 3ds and I got y working for him but after he lost our nuzloke when we tried re randomizing I can’t get it to work for him we have the patch in sd card luma titles and Pokémon y id with rom fs and code.bin file

@twadepsvita
Copy link

I'm trying to make a custom multi-video cia and am getting an error. Would it be possible to just run it as a rom hack of the base title if I have all the files already?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment