Guide:Replacing strings: Difference between revisions
Added infobox, tweaked layout, added todo tag
TheOnlyZac (talk | contribs) (Added PAL instructions, updated command line arguments) |
TheOnlyZac (talk | contribs) (Added infobox, tweaked layout, added todo tag) |
||
Line 1:
{{Infobox guide
| sly2 = y
| sly3 =
| difficulty = Easy
}}
This tutorial will walk you through the steps of using [[Sly String Toolkit]] to make mods that replace strings in Sly 2.
'''Note:''' The toolkit currently only works with Sly 2 NTSC and Sly 2 PAL. It will be updated in the future to work with Sly 3.
{{To do|Add instructions for how to use Live Edit to update the strings in real time.}}
== Setup ==
=== Sly String Toolkit ===
First, download Sly String Toolkit from github [https://github.com/TheOnlyZac/sly-string-toolkit/releases here]. If you have git, you can also clone the latest version directly from the repo, but this guide is probably only accurate for the latest release version.
=== Python ===
You will need to install Python 3.8 or higher from [https://www.python.org/downloads/ here] if you don't already have it. Then, open a command prompt and <code>cd</code> into the folder with the <code>main.py</code> script. Finally, run <code>pip install -r requirements.txt</code> to install the script dependencies. Now you're ready to generate a pnach file!
===
The string toolkit comes with some
To generate the <code>.pnach</code> file, open a command prompt in the project directory and run this command:
Line 21 ⟶ 31:
This will generate a <code>.pnach</code> file in the <code>out</code> folder for the NTSC version. If you are playing on PAL version, add <code>--region pal</code> to the command. Then copy the pnach file to your <code>pcsx2/cheats</code> folder, enable cheats, and start Sly 2. You should see the new text on the title screen.
[[File:String Toolkit screenshot.png|480px]]
==
=== Making a CSV file ===
To make your own string replacement mods, you will need to make a csv file (a spreadsheet) with all the custom strings you want. Each row should have the following format:
<code><string id>,<string>,<optional target address></code>
*
*
*
Everything after the third column is ignored by the script, so you can use them for notes if you want. You can use the csv file from the example project as a base or make the file in Excel or Google Sheets, then export it as a CSV.
Line 36 ⟶ 47:
You can use the <code>test.csv</code> in the exampled folder as a template if you want.
==== String IDs ====
Every string in the game has a unique ID. You will need to know the ID of any string you want to replace. Fortunately, the game stores all these strings in a large table, which we have compiled into [https://docs.google.com/spreadsheets/d/1W-20RZ1hBz7ZtgRBKCNkH84MxkYsoqesDEBGv8l5BdA/edit?usp=sharing this spreadsheet]. However, the sheet is incomplete and will be expanded in the future.
Line 48 ⟶ 58:
</pre>
==
Once you are ready to
<pre>python main.py <path_to_your_csv_file></pre>
Line 60 ⟶ 70:
This will generate a file called <code><nowiki><crc>.mod.pnach</nowiki></code> in the <code>out</code> folder. Place the pnach file in your <code>pcsx2/cheats</code> folder and enable cheats, and your custom strings should appear in game.
===
For a faster workflow, you can use the <code>-o</code> option to set your output directory to your <code>pcsx2/cheats</code> folder so you don't have to copy the file over every time you run the script. Run the script as follows:
Line 74 ⟶ 84:
</pre>
==
That's everything you need to know to make string replacement mods for Sly 2. If you have any questions, feel free to ask in the #mod-help channel on the Discord server.
| |||