Sly String Toolkit: Difference between revisions

From SlyMods
Jump to navigation Jump to search
Content added Content deleted
(Created page for modding tool)
 
(Expanded tool article)
Line 7: Line 7:
}}
}}


''Sly String Toolkit'' is a suite of scripts for making string replacement mods for {{Sly 2}}.
'''Sly String Toolkit''' is Python script-based tool for making string replacement mods for {{Sly 2}}. For a tutorial on how to use it, see [[Guide:Replacing strings]].


== Usage ==
{{Stub}}

<code>python main.py <options></code>

The script supports the following optional arguments:

* <code>-i <inputfile></code> - The name of the input csv file (default is `./strings.csv`)
* <code>-o <outputfile></code> - The name of the output pnach file (default is `out/07652DD9.mod.pnach`)
* <code>-a <address></code> - The address to write the strings to (default is `203C7980`)
* <code>-d</code> - Output `out.asm` and `out.bin` files for debugging
* <code>-v</code> - Enable verbose output
* <code>-h</code> - Show help

== How to use ==
{{Main|Guide:Replacing strings}}

The script takes as input a <tt>.csv</tt> file with a list of string IDs and replacement strings. It outputs a <tt>.pnach</tt> file which you should place in your <code>pcsx2/cheats</code> folder. Make sure to enable cheats before booting the game.

== Strings file format ==

The input is a <tt>.csv</tt> file where each row has the following format:

<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.

{{Navbox tools}}

Revision as of 22:24, 10 February 2023

Sly String Toolkit
Tool
Creator TheOnlyZac
Initial ReleaseFebruary 10, 2023
GitHubtheonlyzac/sly-string-toolkit

Sly String Toolkit is Python script-based tool for making string replacement mods for Sly 2: Band of Thieves. For a tutorial on how to use it, see Guide:Replacing strings.

Usage

python main.py <options>

The script supports the following optional arguments:

  • -i <inputfile> - The name of the input csv file (default is `./strings.csv`)
  • -o <outputfile> - The name of the output pnach file (default is `out/07652DD9.mod.pnach`)
  • -a <address> - The address to write the strings to (default is `203C7980`)
  • -d - Output `out.asm` and `out.bin` files for debugging
  • -v - Enable verbose output
  • -h - Show help

How to use

The script takes as input a .csv file with a list of string IDs and replacement strings. It outputs a .pnach file which you should place in your pcsx2/cheats folder. Make sure to enable cheats before booting the game.

Strings file format

The input is a .csv file where each row has 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.