Guide:Replacing strings: Difference between revisions
Jump to navigation
Jump to search
Added PAL instructions, updated command line arguments
TheOnlyZac (talk | contribs) (Updated setup instructions) |
TheOnlyZac (talk | contribs) (Added PAL instructions, updated command line arguments) |
||
Line 1:
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
== Setup ==
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.
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!
=== Example project ===
The string toolkit comes with
To generate the <code>.pnach</code> file, open a command prompt
<pre>
python main.py
</pre>
[[File:String Toolkit screenshot.png]]
Line 33:
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.
You can use the <code>test.csv</code> in the exampled folder as a template if you want.
=== String IDs ===
Line 50 ⟶ 52:
Once you are ready to test the mod, run the script with the following command:
<pre>python main.py
The default region is NTSC. If you are playing on PAL, you can specify the region with the <code>-r</code> option as follows:
<pre>python main.py <path_to_your_csv_file> -r pal</pre>
This will generate a file called <code>
=== Setting the output directory ===
Line 65:
<pre>
python main.py
</pre>
Line 71:
<pre>
python main.py
</pre>
|