Skip to main content

Utility for editing actors in LoZ:BotW

Project description

Breath of the Wild Actor Editor

Utility for editing actors in LoZ:BotW

Dependencies

  • A dumped copy of Legend of Zelda: Breath of the Wild (for Wii U or Switch)
  • Python 3.7+ (64-bit, added to system PATH)

The following pip packages, which will be automatically installed:

  • wxPython
  • PyMsyt
  • oead

Setup

  1. Download and install Python 3.7+, 64-bit. You must choose the "Add to System PATH" option during installation.
  2. Open a command line and run pip install botw_actor_tool

How to Use

botw_actor_tool

  • Open the tool with this command
  • Set your paths in the Settings before trying to load any actors. It won't be able to find actor lists if it has no paths.
    • Paths are the same as they are in BCML
    • Settings has a dark mode option. The option is currently terrible. Use it at your own risk.
  • Load a vanilla actor by using Ctrl+N or File -> Load Vanilla Actor. This will open a window that will allow you to choose the vanilla actor to load.
  • Load a mod actor by using Ctrl+O or File -> Load Mod Actor. This will open a window that will allow you to choose your mod's content or romfs folder, and will then find any actors in that mod's Actor/Pack folder and display them for you to choose which one to load.
  • Save by using Ctrl+S or File -> Save. Note that any changes to individual files/links that you haven't applied/saved will be lost.

Layout

Actor Link

This contains an entry for every "link" in the ActorLink file, plus a section for Tags.

  • Links can be "Dummy" (no file), the actor's name, or a custom name. Selecting "Custom" won't actually do anything until you enter a custom name and click Update Custom Link.
  • Tags are comma-separated, and will support as many or as few tags as you need.
Text Editors

Most tabs will open up text editors that allow you to edit the yaml of the files in question, and will then convert it back to aamp or byml when you click the Save button at the bottom.

  • If you don't click the Save button at the bottom, your changes will be lost on switching tabs.
Texts Tab

Not to be confused with the text editor tabs, the texts tab is where you edit the texts of your item in-game. Things like its description, name, and compendium summary.

  • BaseName - The name to display in the inventory. Only valid for cookable recipes that have more than one outcome.
  • Name - The name to display in the inventory for most items.
  • Desc - The inventory description of an actor that can go in Link's inventory.
  • PictureBook - The description of an actor, as it appears in the compendium after you've taken a picture of it.

Obscure Features

  • Putting the name of a file that exists in vanilla into a Custom link text field and then clicking Update Custom Link will retrieve that vanilla file's data and ask if you want to import it to your actor.
  • Editing a file with a custom name will prompt you to change the name. This is due to BotW assuming that all files with the same name contain the same data, and only loading one of them.

Contributing

This software is in early, but usable, beta. Only extensively tested with armor and weapon actors, but should work fine with other actor types. Feel free to report issues or otherwise contribute in any way.

License

This software is licensed under the terms of the GNU Affero General Public License, version 3+. The source is publicly available on Github.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

botw_actor_tool-0.1.1.tar.gz (167.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

botw_actor_tool-0.1.1-py3-none-any.whl (191.5 kB view details)

Uploaded Python 3

File details

Details for the file botw_actor_tool-0.1.1.tar.gz.

File metadata

  • Download URL: botw_actor_tool-0.1.1.tar.gz
  • Upload date:
  • Size: 167.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for botw_actor_tool-0.1.1.tar.gz
Algorithm Hash digest
SHA256 af51fb74bd1c9597cfa2b09e31ffab71a0d4242358c52c4ec6eddbcb5b9541ca
MD5 5c6409a760751726addfaa27949dd5bb
BLAKE2b-256 5ca6b4170584547172ab853ba5f8b4892fd35998e1a73c211f0ea3a2fe6f691e

See more details on using hashes here.

File details

Details for the file botw_actor_tool-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: botw_actor_tool-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 191.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for botw_actor_tool-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24ec3adeaba5102f726777dad770b613217526f238f2a5449b2f5b0f11a42cf1
MD5 e3eb7cf79d6fbd166fd37e1ec6ce15c9
BLAKE2b-256 203f0c47cf80f3e404aefaa8329d446736281d15447d9538f144c3a4ab6397f9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page