Help:Tools/EventEditor: Difference between revisions
Jump to navigation
Jump to search
→Enabling auto completion support
imported>Leoetlino No edit summary |
imported>Leoetlino |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== | [[Category:Tools]] | ||
[[Category:Tools (BFEVFL)]] | |||
{{Tool infobox | |||
| name = EventEditor | |||
| authors = leoetlino | |||
| source = https://github.com/leoetlino/event-editor | |||
| license = GPLv2+ | |||
| written_in = Python | |||
| win_only = | |||
}} | |||
# Install PyQt5. | EventEditor is a graphical editor for [[event flow]]s. 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 <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}} 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 19: | 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 | 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 == | ||
| Line 26: | Line 45: | ||
* On Windows: at <code>%APPDATA%/eventeditor/eventeditor.ini</code> | * On Windows: at <code>%APPDATA%/eventeditor/eventeditor.ini</code> | ||
== Known issues == | |||
* '''Does not support event timelines yet''': Timelines are not supported at all currently. | |||