Ginger: /* Setup */ Fix bcml python version

2025-02-24T05:28:10Z

Setup: Fix bcml python version

← Older revision		Revision as of 05:28, 24 February 2025
Line 13:		Line 13:
	#Ensure you have a '''64 bit version''' of Python 3.7+ installed and added to your PATH.		#Ensure you have a '''64 bit version''' of Python 3.7+ installed and added to your PATH.
	#Install the <code>botw_flag_util</code> pip package. {{Install py package help\|package=botw_flag_util}}		#Install the <code>botw_flag_util</code> pip package. {{Install py package help\|package=botw_flag_util}}
	#If you have not already used [[Help:Tools/BCML\|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+'''.		#If you have not already used [[Help:Tools/BCML\|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.9+'''.

	==Usage==		==Usage==

Ginger: Creation

2020-10-20T01:02:40Z

Creation

New page

[[Category:Tools]]
{{Tool infobox
| name = BotW Flag Util
| authors = Ginger
| source = https://github.com/GingerAvalanche/botw_flag_util
| license = AGLPv3+
| written_in = Python
}}

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

==Setup==
#Ensure you have a '''64 bit version''' of Python 3.7+ installed and added to your PATH.
#Install the <code>botw_flag_util</code> pip package. {{Install py package help|package=botw_flag_util}}
#If you have not already used [[Help:Tools/BCML|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===
<code>botw_flag_util generate [path_to_mod_root] [-a] [-r # #] [-b] [-v]</code>

*<code>path_to_mod_root</code> - The path to the root folder of your mod, which contains the content folder. Required.
*<code>-a</code> - Generate actor flags.
*<code>-r # #</code> - 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.
*<code>-b</code> - Use big-endian mode. For generating flags for Wii U.
*<code>-v</code> - Use verbose mode. Will give more verbose after-action report.

===Finding flags===
<code>botw_flag_util find [path_to_mod_root] [search_name] [-b] [-v]</code>

*<code>path_to_mod_root</code> - The path to the root folder of your mod, which contains the content folder. Required.
*<code>search_name</code> - 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.
*<code>-b</code> - Use big-endian mode. For deleting flags for Wii U.
*<code>-v</code> - 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:

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

==Known Issues==

*botw_flag_util uses [[Help:Tools/BCML|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.

Help:Tools/botw flag util - Revision history

Ginger: /* Setup */ Fix bcml python version

Ginger: Creation