Clovermoon modding tutorial

For modding Nintendo Switch version with LayeredFS; Version 0.1

This tutorial will be for modding game in Ryujinx/Yuzu, but also can be used for Switch with CFW that supports LayeredFS.

Dumping game and setting up emulator

For dumping game and setting up emulator use tutorial made by emulator provider:

Ryujinx is recommended, but yuzu will work too.

Extracting game files

Once you have the game in NSP/XCL file and you see it in the emulator window, first thing you must do is to extract romFS from the game. Simply right click on the game in emulator window and choose Extract data -> RomFS

extracting

The extracted files would be in the same directory as the NSP/XCL file. Those files will be necessary to mod the game.

Creating mod directory

To make mod, simply right click on the game in the emulator window and chose Open mods directory

menu

In this folder, you need to create another folder with the name of the mod. In this tutorial we will call it deepLuna. Once you created that folder, create another folder in this new folder named romFS. In this folder you need to insert extracted files in the previous step. You need to copy:

  • script_text.mrg
  • allscr.mrg

You can also copy this folder:

  • ja
  • ja2
  • ja3
  • movies

But this is not necessary.

Modifying game files

Setting up deepLuna

Download python3.X and install it
https://www.python.org/downloads/

Download deepLuna, insert it into mod folder (deepluna.py and other files/folders must be in the same directory as script_text.mrg)
https://github.com/Hakanaou/deepLuna

To open deepLuna simply open cmd in mod folder (by right clicking in the folder while holding shift and picking open CMD (command line) window here), then write python deepluna.py and you should see working deepLuna. You can get an error while trying to open deepLuna for the first time, read error carefully. You will be probably missing some python libraries. To install them, simply write in cmd:
pip install [library_name]
For example: pip install pillow

Extracting game files

Open deepLuna and click Extract text

Extracting translation and uploading it to github

Click open translation and pick scene you want to edit. Then pick a line, write translation, click validate and then save. After doing whole scene you can export it and push on Github by doing pull request.
To see which file needs editing see this spreadsheet so you don't translate something that is translated:
https://1drv.ms/x/s!AjxBEgjI1epPavQoiTYlybTLSCE?e=A0xxiJ
If you don't have permission to edit spreadsheet to announce you are translating something, it is save to translate for now everything after day 5 of Arcueid route and whole of Ciel route.

Injecting translation from Github

Download curent_en_script folder from Tsukihimates repository and move contest of it into upload folder. Then launch deepLuna and open translation, downloaded translation from update folder will be automatically applied and you will see it in deepLuna window. After that click Inject, close deepLuna, rename script_text[date].mrg to script_text.mrg in the mod folder and launch the game. You will see now translated text in the game.

Edit
Pub: 19 Sep 2021 09:22 UTC
Edit: 19 Sep 2021 09:34 UTC
Views: 1111