Help:Tools/botw flag util

< Help:Setting up tools
Revision as of 01:02, 20 October 2020 by Ginger (talk | contribs) (Creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
BotW Flag Util
Author(s) Ginger
Source code https://github.com/GingerAvalanche/botw_flag_util
License AGLPv3+
Written in Python
Platform support Cross-platform

Breath of the Wild Flag Utilities is a flag manager and generator for BotW mods. It can be used to automatically create gamedata flags for many of BotW's use cases, including actors, shrines, and enemy/item revival flags.

Setup

  1. Ensure you have a 64 bit version of Python 3.7+ installed and added to your PATH.
  2. Install the botw_flag_util pip package. [CLI help]
  3. If you have not already used bcml, it will be installed with botw_flag_util. Run it once and set the paths to your dumps. Note that bcml will not work with Python 3.8+.

Usage

Generating flags

botw_flag_util generate [path_to_mod_root] [-a] [-r # #] [-b] [-v]

  • path_to_mod_root - The path to the root folder of your mod, which contains the content folder. Required.
  • -a - Generate actor flags.
  • -r # # - Generate revival flags. The first number is the ResetType for MainField actors. The second is the ResetType for CDungeon (shrine) actors. If one of them is set to -1, it will skip flag generation for that field type.
  • -b - Use big-endian mode. For generating flags for Wii U.
  • -v - Use verbose mode. Will give more verbose after-action report.

Finding flags

botw_flag_util find [path_to_mod_root] [search_name] [-b] [-v]

  • path_to_mod_root - The path to the root folder of your mod, which contains the content folder. Required.
  • search_name - The name of the flag to search for. Will find all flags whose DataName contains search_name. For example, MainField_Npc_HiddenKorok will find all Korok NPC flags.
  • -b - Use big-endian mode. For deleting flags for Wii U.
  • -v - Use verbose mode. Will give more verbose after-action report.

Once the search has been completed, you will be told how many game data and save data flags were found that matched search_name. You will then be given three choices:

  • v - View more detailed information on the flags found: their full names and their types, and then prompt for another choice.
  • d - Delete all the flags that were found by this search, and then return to the command line.
  • x - Return to the command line.

Known Issues

  • botw_flag_util uses bcml to find the locations of some of your vanilla files. If you haven't installed/run bcml and set your paths in it, botw_flag_util will not be able to find some of the files it needs.