Help:Tools/EventEditor: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
VisualWikitext
imported>Leoetlino
No edit summary
imported>Leoetlino
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Installing ==
[[Category:Tools]]
Important: ensure you have a '''64 bit version''' of Python 3.'''6+''' before continuing. You will not be able to install EventEditor otherwise.
[[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. (If you're on Windows, install the <code>PyQt5</code> package. {{Install py package help|package=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}}


The editor can now be launched with the <code>eventeditor</code> command. {{CLI help}}
== 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 extracting every archive is to use [[Help:Setting up botwfstools|botwfstools]].''
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>


[[Category: Guides]]
== Known issues ==
[[Category: Guides (tools)]]
* '''Does not support event timelines yet''': Timelines are not supported at all currently.

Latest revision as of 20:04, 8 September 2019

EventEditor
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

  1. Ensure you have a 64 bit version of Python 3.6+ before continuing. You will not be able to install or launch EventEditor otherwise.
  2. 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] Also install the PyQtWebEngine package [CLI help].
  3. Install the eventeditor package. [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.
Retrieved from "https://zeldamods.org/w_botw/index.php?title=Help:Tools/EventEditor&oldid=2268"