citra-emu
/
citra-web
Archived
1
0
Fork 0
Code

Merge pull request #126 from zhaowenlan1779/game-modding-3 

Update game modding article to reflect drop-in compatibility with Luma mods
This commit is contained in:
Schplee 2020-03-02 23:29:41 -08:00 committed by GitHub
parent 91df5ebb0b 9762c7043b
commit b0d9f3a788
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
site/content/help/feature/game-modding.md
View File

@ -31,6 +31,8 @@ More details on the `IPS` format can be found on [ZeroSoft](https://zerosoft.zop
To use a `BPS` patch, put a file named `code.bps` in the ExeFS directory. To use a `BPS` patch, put a file named `code.bps` in the ExeFS directory.
More details on the `BPS` format can be found on [byuu](https://byuu.org/projects/beat#bps). More details on the `BPS` format can be found on [byuu](https://byuu.org/projects/beat#bps).
*Note: For compatiblity with Luma3DS, you can also put these ExeFS replacements/patches directly in the mods folder instead of the `exefs` subfolder.*
#### RomFS #### RomFS
The RomFS directory contains replacements for the game's assets and general files. The RomFS directory contains replacements for the game's assets and general files.
These types of mods typically alter a game's textures, text, fonts, sounds, or other graphical assets. These types of mods typically alter a game's textures, text, fonts, sounds, or other graphical assets.
@ -65,9 +67,9 @@ Within this folder, there are `exefs`, `romfs`, and `romfs_ext` directories and
It is okay to omit one (or more) of them if the mod does not need to replace those files. Additionally, if a folder is empty Citra will ignore it. It is okay to omit one (or more) of them if the mod does not need to replace those files. Additionally, if a folder is empty Citra will ignore it.
### Using Mods Intended for Luma3DS ### Using Mods Intended for Luma3DS
Citra's game modding framework has all the functionality offered in Luma3DS's game patching feature. Therefore, mods intended for Luma3DS should be usable with Citra. Citra's game modding framework offers drop-in compatibility with Luma3DS mods.
Mods for Luma3DS usually look like: Just put a Luma3DS mod (usually structured like the following example) into Citra's mod folder for the title, and it should directly work.
``` ```
luma/titles/<Title ID> luma/titles/<Title ID>
- romfs - romfs
@ -77,12 +79,6 @@ luma/titles/<Title ID>
``` ```
Note that everything demonstrated above is optional. It is possible that a mod contains only some of these files. Note that everything demonstrated above is optional. It is possible that a mod contains only some of these files.
You need to copy the files to Citra's mod folder for the corresponding title. Then, you should make an `exefs` folder and move `code.bin` or `code.ips` inside.
```
It is important to note that you need to move the code replacements/patches to the `exefs` subfolder!
Directly putting a Luma3DS mod will likely not result in it being applied.
```
### Conclusion ### Conclusion
If you are a modder looking to distribute mods for Citra and have further questions or doubts, feel free to ask in our Discord. If you are a modder looking to distribute mods for Citra and have further questions or doubts, feel free to ask in our Discord.