Help:Tools/EventEditor

Prerequisites

Ensure you have a 64 bit version of Python 3.6+ before continuing. You will not be able to install or launch EventEditor otherwise.

Older versions of Windows such as Windows 7 are not recommended because of incompatibilities in the Qt library; you may need to manually install an older version of PyQt5 if you are on an old OS.

Installing

Install PyQt5.
- If you're on Linux, use your package manager. The package for Debian is called python3-pyqt5. You will also need to install python3-pyqt5.qtwebengine.
- If you're on Windows, install the PyQt5 package. ^{[CLI help]}
Install the eventeditor package. ^{[CLI help]}

The editor can now be launched with the eventeditor command. ^[help]

Enabling auto completion support

To avoid having to type actor, parameter, action and query names manually, EventEditor has built-in support for auto completion.

To enable the feature, the program must be configured to look in the game's content files by adding:

[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.

Configuration file

The configuration file is stored:

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