Help:Creating mods: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>BravelyPeculiar
(added aamp)
imported>BravelyPeculiar
(Added some file formats)
Line 1: Line 1:
{{Stub|what=}}
{{Stub|what=}}
Welcome, modders! This page is intended to be a collection of useful information for new and existing modders.
Welcome, modders! This page is intended to be a collection of useful information for new and existing modders.


== Getting Started - Tools ==
== Getting Started - Tools ==
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, and tick the "Add to PATH"/"Add to environment variables" box in the installer. Then, to install the tool, run `pip install TOOL_NAME` 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 `pip install TOOL_NAME` in the command line.
* [[AAMP]] files contains parameters for actors and other game elements. Edit them with leoetlino's [https://pypi.org/project/aamp/ `aamp` library]. Run with `aamp_to_yml INPUT_FILE OUTPUT_FILE.yml`, and vice versa.
* Many files in the game are compressed with [[Yaz0]] compression. Compressed files generally have the letter s 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).
* [[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].
* [[AAMP]] files also contain game parameters. Convert them to an editable format (and back) with leoetlino's [https://pypi.org/project/aamp/ aamp tool].
* [[SARC]] archives contain other files, sort of like .zip folders. Extract, edit and re-pack them with leoetlino's [https://pypi.org/project/sarc/ <code>sarc</code> tool].

Revision as of 22:42, 14 October 2018

Welcome, modders! This page is intended to be a collection of useful information for new and existing modders.

Getting Started - Tools

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 `pip install TOOL_NAME` in the command line.

  • Many files in the game are compressed with Yaz0 compression. Compressed files generally have the letter s prefixed to their file extension. To decompress and recompress these files, use wszst(use the download marked Cygwin if you're running Windows).
  • BYML files contain game parameters. Convert them to an editable format (and back) with leoetlino's byml tool.
  • AAMP files also contain game parameters. Convert them to an editable format (and back) with leoetlino's aamp tool.
  • SARC archives contain other files, sort of like .zip folders. Extract, edit and re-pack them with leoetlino's sarc tool.