Guide:Replacing strings: Difference between revisions
TheOnlyZac (talk | contribs) (Added images, misc tweaks) |
TheOnlyZac (talk | contribs) (Updated lead) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Infobox guide |
|||
⚫ | |||
| sly2 = y |
|||
| sly3 = |
|||
| difficulty = Easy |
|||
}} |
|||
⚫ | |||
⚫ | |||
⚫ | |||
{{To do|Add instructions for how to use Live Edit to update the strings in real time.}} |
|||
== Setup == |
== 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. |
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! |
|||
=== Build example PNACH === |
|||
⚫ | |||
⚫ | The string toolkit comes with some example input files in the <code>examples</code> directory. There you will find a file called <code>test.csv</code>. It contains two strings that replace the text on the title screen, "Press START button for New Game" and "Press SELECT button for Menu" with "Sly String Toolkit" and the link to the GitHub repo. |
||
⚫ | |||
⚫ | |||
<pre> |
<pre> |
||
python main.py |
python main.py example/string.csv |
||
</pre> |
</pre> |
||
This will generate a <tt>.pnach</tt> file in the <tt>out</tt> 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 strings on the title screen. |
|||
[[File:String Toolkit screenshot.png]] |
[[File:String Toolkit screenshot.png|480px]] |
||
== |
==Adding custom strings== |
||
=== Making a CSV file === |
|||
To make your own string replacement mods, you will need to make a |
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> |
<code><string id>,<string>,<optional target address></code> |
||
* |
*<code><string id></code> is the ID of the string you want to replace |
||
* |
*<code><string></code> is the string to replace it with |
||
* |
*<code><optional target address></code> is the address to write the string to. If not specified, it will be written with the rest of the strings in a block at the address specified by the <code>-a</code> option. |
||
Everything after the third column is ignored by the script, so you can use them for notes if you want. You can use |
Everything after the third column is ignored by the script, so you can use them for notes if you want. You can use example CSV as a template, or make a spreadsheet in Excel or Google Sheets and export it as a CSV. |
||
=== String IDs === |
==== 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 dumped into [https://docs.google.com/spreadsheets/d/1W-20RZ1hBz7ZtgRBKCNkH84MxkYsoqesDEBGv8l5BdA/edit?usp=sharing this spreadsheet]. |
||
⚫ | 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 |
||
Find the string in the string table you want to replace, and in your spreadsheet put that ID in the first column. In the second column, put the string you want to replace it with. |
Find the string in the string table you want to replace, and in your spreadsheet put that ID in the first column. In the second column, put the string you want to replace it with. |
||
For example, if you want to replace the string "WE'LL BE RIGHT BACK!" on the pause menu (which has ID 309) with " |
For example, if you want to replace the string "WE'LL BE RIGHT BACK!" on the pause menu (which has ID 309) with "MODDING IS FUN!", your csv should look like this: |
||
<pre> |
<pre> |
||
309, |
309,MODDING IS FUN! |
||
</pre> |
</pre> |
||
== |
==Generating the mod PNACH== |
||
When you are ready to generate the PNACH file, run the script with the following command: |
|||
<pre>python main.py |
<pre>python main.py <path_to_your_csv_file></pre> |
||
The default region is NTSC. You can specify the region with the <code>-r</code> option like this: |
|||
If you aren't familiar with the command line and don't know how to input the path to your csv file, just name it <code>strings.csv</code> and put it in the same folder as <code>main.py</code> script. Then simply run the script with: |
|||
<pre>python main.py <path_to_your_csv_file> -r pal</pre> |
|||
<pre> |
|||
python main.py |
|||
</pre> |
|||
This will generate a file called <code> |
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. |
||
=== |
===Setting the output directory=== |
||
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: |
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: |
||
<pre> |
<pre> |
||
python main.py |
python main.py <path_to_your_csv_file> -o <path_to_pcsx2_cheats_folder> |
||
</pre> |
</pre> |
||
Your PCSX2 folder |
Your PCSX2 folder folder is probably something like this: <tt>C:\Users\Yourname\My Documents\PCSX2 1.6.0\cheats</tt>. So, you can run the script as follows (with quotation marks around the directory): |
||
<pre> |
<pre> |
||
python main.py |
python main.py <path_to_your_csv_file> -o "C:\Users\Yourname\My Documents\PCSX2 1.6.0\cheats" |
||
</pre> |
</pre> |
||
{{Navbox guides}} |
|||
== Conclusion == |
|||
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. |
|||
{{Comments}} |
Latest revision as of 19:34, 13 September 2023
Modding Guide | |
---|---|
Game(s) | Sly 2: Band of Thieves |
Difficulty | Easy |
This tutorial will walk you through the steps of using Sly String Toolkit to string replacement mods for Sly 2 on the PS2.
Note: The toolkit currently only works with Sly 2 PS2 (NTSC and 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 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 here if you don't already have it. Then, open a command prompt and cd
into the folder with the main.py
script. Finally, run pip install -r requirements.txt
to install the script dependencies. Now you're ready to generate a pnach file!
Build example PNACH
The string toolkit comes with some example input files in the examples
directory. There you will find a file called test.csv
. It contains two strings that replace the text on the title screen, "Press START button for New Game" and "Press SELECT button for Menu" with "Sly String Toolkit" and the link to the GitHub repo.
To generate the .pnach
file, open a command prompt in the project directory and run this command:
python main.py example/string.csv
This will generate a .pnach file in the out folder for the NTSC version. If you are playing on PAL version, add --region pal
to the command. Then copy the pnach file to your pcsx2/cheats
folder, enable cheats, and start Sly 2. You should see the new strings on the title screen.
Adding custom strings
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:
<string id>,<string>,<optional target address>
<string id>
is the ID of the string you want to replace<string>
is the string to replace it with<optional target address>
is the address to write the string to. If not specified, it will be written with the rest of the strings in a block at the address specified by the-a
option.
Everything after the third column is ignored by the script, so you can use them for notes if you want. You can use example CSV as a template, or make a spreadsheet in Excel or Google Sheets and export it as a CSV.
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 dumped into this spreadsheet.
Find the string in the string table you want to replace, and in your spreadsheet put that ID in the first column. In the second column, put the string you want to replace it with.
For example, if you want to replace the string "WE'LL BE RIGHT BACK!" on the pause menu (which has ID 309) with "MODDING IS FUN!", your csv should look like this:
309,MODDING IS FUN!
Generating the mod PNACH
When you are ready to generate the PNACH file, run the script with the following command:
python main.py <path_to_your_csv_file>
The default region is NTSC. You can specify the region with the -r
option like this:
python main.py <path_to_your_csv_file> -r pal
This will generate a file called <crc>.mod.pnach
in the out
folder. Place the pnach file in your pcsx2/cheats
folder and enable cheats, and your custom strings should appear in game.
Setting the output directory
For a faster workflow, you can use the -o
option to set your output directory to your pcsx2/cheats
folder so you don't have to copy the file over every time you run the script. Run the script as follows:
python main.py <path_to_your_csv_file> -o <path_to_pcsx2_cheats_folder>
Your PCSX2 folder folder is probably something like this: C:\Users\Yourname\My Documents\PCSX2 1.6.0\cheats. So, you can run the script as follows (with quotation marks around the directory):
python main.py <path_to_your_csv_file> -o "C:\Users\Yourname\My Documents\PCSX2 1.6.0\cheats"