View source for Use TBCTK as a replacement to BCGM Python

If you don't want to bother rewriting all of your custom content as TBCTK modifications.

== Creating a mod ==

Run the following command to create a blank mod

<syntaxhighlight lang="shell" line>
tbctk-cli init --id testmod -a username -n "Test Mod" --output cool_dir
</syntaxhighlight>

This will create a mod in the directory cool_dir in the current working directory.

== Adding raw APK files ==

Raw files are files which are in the APK itself. This can be stuff like raw .pack and .list files, xml files, libraries, etc.

In the mod directory create a file called <code>raw_pkg.toml</code> (or whatever you want), with the following content.

<syntaxhighlight lang="toml" line>
[[dirs]]
path = "./pkg_files/"
recursive = true
</syntaxhighlight>

Then create a <code>pkg_files</code> directory in the mod folder.

Place all of your modded files in this directory. If you want to place files in a subdirectory in the APK, then just place the files in a folder with the same name.

E.g if you want to replace <code>assets/DataLocal.pack</code>, then add your modified file in <code>mod_folder/pkg_files/assets/DataLocal.pack</code>.

Then in <code>path.toml</code> you should add the following entry:

<syntaxhighlight lang="toml" line>
[[paths]]
mod_type = "pkg_files"
paths = ["./raw_pkg.toml"]
</syntaxhighlight>

Change <code>raw_pkg.toml</code> if you put the raw files metadata in a different file.

== Adding raw game files ==

Raw game files are files inside the pack files, for example localizable.tsv.

Create a file called <code>game_files.toml</code>

[[Category:Guides]]