Help:Adding items - Revision history

Nebroc: Added link to Icon maker

2025-11-25T22:30:41Z

Added link to Icon maker

← Older revision		Revision as of 22:30, 25 November 2025
Line 115:		Line 115:
	===Creating an inventory icon===		===Creating an inventory icon===
	This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].sbitemico</code>, the name of the file it contains in Toolbox to <code>[NewActorName].bitemico</code>, and the texture it contains to <code>[NewActorName]</code>		This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].sbitemico</code>, the name of the file it contains in Toolbox to <code>[NewActorName].bitemico</code>, and the texture it contains to <code>[NewActorName]</code>

			Note: You can also very easily creating your own icon from a png using [https://gamebanana.com/tools/16205 this tool].

	===Installing the mod===		===Installing the mod===

HGStone: Updated the Python Versions and the name of BCML.

2022-08-29T23:59:16Z

Updated the Python Versions and the name of BCML.

← Older revision		Revision as of 23:59, 29 August 2022
Line 7:		Line 7:

	Both methods require the following:		Both methods require the following:
	*[https://www.python.org/downloads/release/python-379/ Python 3.7] (64-bit) is necessary for just about every tool ~~(Python 3~~.~~8 exists, but is not currently compatible with [[Help:Tools/aamp\|aamp]] or [[Help:Tools/BCML\|BCML]])~~		*[https://www.python.org/downloads/release/python-379/ Python 3.7] (64-bit) or [https://www.python.org/downloads/release/python-3810/ Python 3.8] (64-bit) is necessary for just about every tool.
	*[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox]		*[https://github.com/KillzXGaming/Switch-Toolbox/releases Switch Toolbox]
	*~~Breath of the Wild Cemu~~ Mod Loader (or <code>bcml</code>) {{Install py package help\|package=bcml}}		*BOTW Cross-Platform Mod Loader (or <code>bcml</code>) {{Install py package help\|package=bcml}}

	The new method requires:		The new method requires:

Kubirill: add link to item library

2021-03-22T08:36:41Z

add link to item library

← Older revision		Revision as of 08:36, 22 March 2021
Line 46:		Line 46:

	===Opening the base actor===		===Opening the base actor===
	Use File -> Open Vanilla Actor to open a list of all actors from vanilla BotW. Pick the actor from the list that most closely matches your new desired item. (e.g. if you want to create a wooden shield, you would pick an actor for one of the base game's wooden shields)		Use File -> Open Vanilla Actor to open a list of all actors from vanilla BotW. Pick the actor from the list that most closely matches your new desired item. (e.g. if you want to create a wooden shield, you would pick an actor for one of the base game's wooden shields).

			Use https://github.com/MrCheeze/botw-tools/blob/master/botw_names.json for help finding item

	Once the tool has loaded the actor data, click on the Model button in the Actor Property box at the top, then scroll to the bottom. There should be a single line that says <code>Folder</code>. Take note of what it says after that, as that is the name of the <code>sbfres</code> file that you will need in [[#Creating your item's resource files]]. Then switch back to the Actor Link tab by clicking on the Actor Link button in the Actor Property box.		Once the tool has loaded the actor data, click on the Model button in the Actor Property box at the top, then scroll to the bottom. There should be a single line that says <code>Folder</code>. Take note of what it says after that, as that is the name of the <code>sbfres</code> file that you will need in [[#Creating your item's resource files]]. Then switch back to the Actor Link tab by clicking on the Actor Link button in the Actor Property box.

Ginger: Update for botw_actor_tool

2020-10-31T09:41:13Z

Update for botw_actor_tool

Show changes

Ginger: /* Adding the actor info */ Fix key instructions

2020-10-24T11:14:40Z

Adding the actor info: Fix key instructions

← Older revision		Revision as of 11:14, 24 October 2020
Line 95:		Line 95:

	*<code>bfres: [BfresName]</code> to your new <code>bfres</code> name		*<code>bfres: [BfresName]</code> to your new <code>bfres</code> name
	*<code>itemUseIconActorName: [ActorName]</code> to your ~~new~~ actor name		*<code>itemUseIconActorName: [ActorName]</code> should have the [ActorName] replaced with just '''""''' if you're using your own icon, otherwise replace it with the actor name of the icon you'll be using
	*<code>mainModel: [ModelName]</code> to your new model name		*<code>mainModel: [ModelName]</code> to your new model name
			*<code>name: [ActorName]</code> to your new actor name
	*Any additional information you changed in the actor pack that might be shown in any menu. For example, armor value of armor, defensive value of shields, damage of weapons, buying/selling price of items from/to a shop, crafting ingredients if the item is craftable, etc.		*Any additional information you changed in the actor pack that might be shown in any menu. For example, armor value of armor, defensive value of shields, damage of weapons, buying/selling price of items from/to a shop, crafting ingredients if the item is craftable, etc.

Ginger: /* My game is crashing after shaders compile! */ RSTB stuff

2020-09-27T08:33:47Z

My game is crashing after shaders compile!: RSTB stuff

Show changes

Ginger: /* Installing the mod */ making rules.txt

2020-09-06T01:22:06Z

Installing the mod: making rules.txt

← Older revision		Revision as of 01:22, 6 September 2020
Line 152:		Line 152:

	=== Installing the mod ===		=== Installing the mod ===
	And now you are done! To use the mod, open <code>bcml</code> via Powershell (just run the command <code>bcml</code>) and select Install... Then select Add Folder, select the <code>BreathOfTheWild_[MyAwesomeModName]</code> folder, and click OK. Wait for it to install, and you're ready to play the game with your new item!		And now you are done! Basically! Use the directions located [https://zeldamods.org/wiki/Help:Using_mods#Installing_mods_with_the_graphic_pack_menu here] to make a rules.txt if you haven't already. To use the mod, open <code>bcml</code> via Powershell (just run the command <code>bcml</code>) and select Install... Then select Add Folder, select the <code>BreathOfTheWild_[MyAwesomeModName]</code> folder, and click OK. Wait for it to install, and you're ready to play the game with your new item!

	== Troubleshooting ==		== Troubleshooting ==

Ginger: /* Intro */ Removed false claim that multiple methods are given for each step

2020-08-22T21:28:17Z

Intro: Removed false claim that multiple methods are given for each step

← Older revision		Revision as of 21:28, 22 August 2020
Line 1:		Line 1:
	Mods that deal with items will often edit items that already exist in the game. However, this can lead to conflicts between mods, so it is generally advised to make a new item, instead. This tutorial will cover all of the steps needed to add new items~~, as well as multiple methods for completing each step~~.		Mods that deal with items will often edit items that already exist in the game. However, this can lead to conflicts between mods, so it is generally advised to make a new item, instead. This tutorial will cover all of the steps needed to add new items.

	== Required tools ==		== Required tools ==

Ginger: /* Creating an inventory icon */ Fixed extension typos

2020-08-22T18:01:25Z

Creating an inventory icon: Fixed extension typos

← Older revision		Revision as of 18:01, 22 August 2020
Line 130:		Line 130:

	=== Creating an inventory icon ===		=== Creating an inventory icon ===
	This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].~~sbitemco~~</code>, the name of the file it contains in Toolbox to <code>[NewActorName].~~bitemco~~</code>, and the texture it contains to <code>[NewActorName]</code>		This section covers the inventory icons, the square images you see in the inventory grid in the pause menu. These files are kept in <code>content\UI\StockItem</code> for inventory items. Copy the old <code>sbitemco</code> file for the item you are using as your foundation, to the same location in your mod files (<code>content\UI\StockItem</code>). An <code>sbitemco</code> file is pretty much the same thing as an <code>sbfres</code> for textures, so you will edit it the same way, using Switch Toolbox. Make sure to change the name of the file to <code>[NewActorName].sbitemico</code>, the name of the file it contains in Toolbox to <code>[NewActorName].bitemico</code>, and the texture it contains to <code>[NewActorName]</code>

	=== Creating an inventory name and description ===		=== Creating an inventory name and description ===

Ginger: Deleted "Python scripts don't print to console" because the ones in the tutorial now do

2020-08-22T17:49:27Z

Deleted "Python scripts don't print to console" because the ones in the tutorial now do

← Older revision		Revision as of 17:49, 22 August 2020
Line 31:		Line 31:
	Note that anytime brackets are used, this means that whatever is inside the brackets should be replaced with something else. For example, <code>Bootup_[XXxx].pack</code> could be replaced with <code>Bootup_USen.pack</code> or <code>Bootup_EUen.pack</code> or other names. Do NOT leave the brackets in there. Another example might be <code>[FileName].[FileExtension]</code> which could be replaced with just about anything, like <code>Weapon_Sword_001.bxml</code> or <code>Link.Tex1.sbfres</code>. (Note that, in this case, "Link.Tex1" is the file name and <code>sbfres</code> is the file extension)		Note that anytime brackets are used, this means that whatever is inside the brackets should be replaced with something else. For example, <code>Bootup_[XXxx].pack</code> could be replaced with <code>Bootup_USen.pack</code> or <code>Bootup_EUen.pack</code> or other names. Do NOT leave the brackets in there. Another example might be <code>[FileName].[FileExtension]</code> which could be replaced with just about anything, like <code>Weapon_Sword_001.bxml</code> or <code>Link.Tex1.sbfres</code>. (Note that, in this case, "Link.Tex1" is the file name and <code>sbfres</code> is the file extension)

	If you are ever told to open a Powershell window and run a command, you can do that by holding shift, right-clicking somewhere inside the folder and clicking on "Open Powershell window here." Anytime you do this, it will be to run a Python script. All BotW modding Python scripts do not print '''anything''' to the Powershell window if they run successfully. If, at any time, one of the commands prints something to the Powershell window, stop right there and see if you can figure out what the problem is, or ask in the Discord.		If you are ever told to open a Powershell window and run a command, you can do that by holding shift, right-clicking somewhere inside the folder and clicking on "Open Powershell window here." Anytime you do this, it will be to run a Python script.

	=== Setting up your folder structure ===		=== Setting up your folder structure ===