Skip to main content

EventEditor for Breath of the Wild

Setup

Install Python 3.6+ (64 bit version) and PyQt5, then run pip install eventeditor.

Configuration

The configuration file is stored:

  • On Linux or macOS: at ~/.config/eventeditor/eventeditor.ini
  • On Windows: at %APPDATA%/eventeditor/eventeditor.ini

Auto-completion

Breath of the Wild

In order to enable auto-completion for actors, actions, and queries, add:

[paths]
rom_root=/path/to/game_rom

to EventEditor's configuration file, where /path/to/game_rom is a path such that /path/to/game_rom/Pack/Bootup.pack/Actor/AIDef/AIDef_Game.product.sbyml exists. An easy, recommended way to get the required file structure without extracting every archive is to use botwfstools.

Other games

Alternatively, JSON actor definitions can be generated under Flowchart > Export actor definition data to JSON. This will generate information for auto-completion from the currently open event flow. The first time this is run, a prompt will appear asking for where to save this information.

This action can be safely repeated in case other event flows contain actors, actions, or queries that have yet to be included in the JSON file (existing entries will not be overwritten).

Known issues

  • On Linux, if the main window view is a completely blank screen, even after opening a file, try running QTWEBENGINE_DISABLE_SANDBOX=1 eventeditor to start the tool.

  • Unlinking events while in fork/join will break graph generation most of the time. So using that option is not recommended when fork/join events are involved.

What needs to be done

  • Timeline files (reverse engineering)

  • Collect event info from EventInfo and have a metadata file for each event flow, so that:

    • EventInfo can be automatically regenerated
    • All copies of an event flow can be automatically updated
  • Node order shuffling to get less crossings. This used to be a dagre.js feature but it got removed...

License

This software is licensed under the terms of the GNU General Public License, version 2 or later.

Metadata

Release files for eventeditor 1.3.9.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for eventeditor 1.3.9.post1
File Interpreter ABI Platform
eventeditor-1.3.9.post1-py3-none-any.whl Python 3 none any Details

Release files / eventeditor-1.3.9.post1-py3-none-any.whl

Download URL eventeditor-1.3.9.post1-py3-none-any.whl
Size 508.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
36289bbdc06ea7d050f4023906c9de2830ff91a34f2b8f6f812f3843e011b7f0
BLAKE2b-256 checksum
How to use checksums
a0ba3e5a22c7bc4fa465f6976c81bfc5548b2eadab659dad05372dd8d41f3aab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

1.3.9.post1 This release

1 release file

1.3.9

1 release file

1.3.8

1 release file

1.3.7

1 release file

1.3.6

1 release file

1.3.5

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page