Help:Creating mods: Difference between revisions

Jump to navigation Jump to search
no edit summary
imported>BravelyPeculiar
imported>BravelyPeculiar
No edit summary
Line 1: Line 1:
{{Stub|what=}}
Welcome, modders! This page is intended to be a collection of useful information for anybody who wants to create mods. If you want to simply use other people's mods, see [[Help:Setting up mods]].
Welcome, modders! This page is intended to be a collection of useful information for anybody who wants to create mods. If you want to simply use other people's mods, see [[Help:Setting up mods]].


== Files, Tools and Tutorials ==
== Files, Tools and Tutorials ==
Since BotW uses a lot of Nintendo's own file formats, you'll need tools to be able to edit them. To use leoetlino's tools, you need to install the latest version of Python (64 bit version), and tick the "Add to PATH" / "Add to environment variables" box in the installer. Then, to install the tool, run <code>pip install TOOL_NAME</code> in the command line.
Since BotW uses a lot of Nintendo's own file formats, you'll need tools to be able to edit them. To use leoetlino's tools, you need to install the latest version of Python (64 bit version), and tick the "Add to PATH" / "Add to environment variables" box in the installer. Then, to install the tool, run <code>pip install TOOL_NAME</code> in the command line.
If you're not sure which tool to use on a file, search for its extension on this wiki to find what file format that extension is used for.
* Many files in the game are compressed with [[Yaz0]] compression. Compressed files generally have the letter <code>s</code> prefixed to their file extension. To decompress and recompress these files, use [https://szs.wiimm.de/wszst/ wszst](use the download marked Cygwin if you're running Windows).
* Many files in the game are compressed with [[Yaz0]] compression. Compressed files generally have the letter <code>s</code> prefixed to their file extension. To decompress and recompress these files, use [https://szs.wiimm.de/wszst/ wszst](use the download marked Cygwin if you're running Windows).
** <code>wszst decompress INPUT_FILE.sbactorpack OUTPUT_FILE.bactorpack</code>
** <code>wszst decompress INPUT_FILE.sbactorpack OUTPUT_FILE.bactorpack</code>
Line 13: Line 14:
* [[BYML]] files contain game parameters. Convert them to an editable format (and back) with leoetlino's [https://pypi.org/project/byml/ <code>byml</code> tool]. This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>.
* [[BYML]] files contain game parameters. Convert them to an editable format (and back) with leoetlino's [https://pypi.org/project/byml/ <code>byml</code> tool]. This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>.
** <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code>
** <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code>
** <code>yml_to_byml [-b] INPUT_FILE.yml OUTPUT_FILE.sbyml</code> (Use <code>-b</code> for Wii U only).
** <code>yml_to_byml [-b] INPUT_FILE.yml OUTPUT_FILE.sbyml</code> (Use <code>-b</code> for Wii U only).
* [[AAMP]] files also contain game parameters. Convert them to an editable format (and back) with leoetlino's [https://pypi.org/project/aamp/ <code>aamp</code> tool].
* [[AAMP]] files also contain game parameters. Convert them to an editable format (and back) with leoetlino's [https://pypi.org/project/aamp/ <code>aamp</code> tool].
** <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code>
** <code>aamp_to_yml INPUT_FILE.bxml OUTPUT_FILE.yml</code>

Navigation menu