Help:Tools/EventEditor: Difference between revisions
imported>Leoetlino No edit summary |
imported>Leoetlino |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
| authors = leoetlino | | authors = leoetlino | ||
| source = https://github.com/leoetlino/event-editor | | source = https://github.com/leoetlino/event-editor | ||
| license = | | license = GPLv2+ | ||
| written_in = Python | | written_in = Python | ||
| win_only = | | win_only = | ||
| Line 16: | Line 16: | ||
# Install PyQt5. | # Install PyQt5. | ||
#* If you're on Linux, use your package manager. The package for Debian is called <code>python3-pyqt5</code>. You will also need to install <code>python3-pyqt5.qtwebengine</code>. | #* If you're on Linux, use your package manager. The package for Debian is called <code>python3-pyqt5</code>. You will also need to install <code>python3-pyqt5.qtwebengine</code>. | ||
#* If you're on Windows, install the <code>PyQt5</code> package. {{Install py package help|package=PyQt5}} | #* If you're on Windows, install the <code>PyQt5</code> package. {{Install py package help|package=PyQt5}} Also install the <code>PyQtWebEngine</code> package {{Install py package help|package=PyQtWebEngine}}. | ||
# Install the <code>eventeditor</code> package. {{Install py package help|package=eventeditor}} | # Install the <code>eventeditor</code> package. {{Install py package help|package=eventeditor}} | ||
== Usage == | |||
EventEditor can be launched with the <code>eventeditor</code> command. {{CLI help}} | |||
Optionally, you may open an event flow directly by passing a path to the bfevfl file (e.g. <code>eventeditor Event/Dummy.bfevfl</code>). | |||
== Enabling auto completion support == | == Enabling auto completion support == | ||
| Line 33: | Line 36: | ||
to EventEditor's configuration file, where <code>/path/to/game_rom</code> is a path such that <code>/path/to/game_rom/Pack/Bootup.pack/Actor/AIDef/AIDef_Game.product.sbyml</code> exists. | to EventEditor's configuration file, where <code>/path/to/game_rom</code> is a path such that <code>/path/to/game_rom/Pack/Bootup.pack/Actor/AIDef/AIDef_Game.product.sbyml</code> exists. | ||
''An easy, recommended way to get the required file structure without having to extract every single archive is to use [[Help: | Use forward slashes even on Windows to avoid escaping issues. | ||
''An easy, recommended way to get the required file structure without having to extract every single archive is to use [[Help:Tools/botwfstools|botwfstools]].'' | |||
== Configuration file == | == Configuration file == | ||
Latest revision as of 20:04, 8 September 2019
| Author(s) | leoetlino |
|---|---|
| Source code | https://github.com/leoetlino/event-editor |
| License | GPLv2+ |
| Written in | Python |
| Platform support | Cross-platform |
EventEditor is a graphical editor for event flows. It can currently only handle event flowcharts; event timelines are not supported yet.
Setup
- Ensure you have a 64 bit version of Python 3.6+ before continuing. You will not be able to install or launch EventEditor otherwise.
- Install PyQt5.
- If you're on Linux, use your package manager. The package for Debian is called
python3-pyqt5. You will also need to installpython3-pyqt5.qtwebengine. - If you're on Windows, install the
PyQt5package. [CLI help] Also install thePyQtWebEnginepackage [CLI help].
- If you're on Linux, use your package manager. The package for Debian is called
- Install the
eventeditorpackage. [CLI help]
Usage
EventEditor can be launched with the eventeditor command. [help]
Optionally, you may open an event flow directly by passing a path to the bfevfl file (e.g. eventeditor Event/Dummy.bfevfl).
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.
Use forward slashes even on Windows to avoid escaping issues.
An easy, recommended way to get the required file structure without having to extract every single 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
Known issues
- Does not support event timelines yet: Timelines are not supported at all currently.