Help:Tools/EventEditor - Revision history

imported>Leoetlino: /* Enabling auto completion support */

2019-09-08T20:04:57Z

Enabling auto completion support

← Older revision		Revision as of 20:04, 8 September 2019
Line 35:		Line 35:

	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.

			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]].''		''An easy, recommended way to get the required file structure without having to extract every single archive is to use [[Help:Tools/botwfstools\|botwfstools]].''

imported>Leoetlino: /* Setup */ the 5.12 pypi package moved WebEngine into PyQtWebEngine

2019-03-01T20:47:32Z

Setup: the 5.12 pypi package moved WebEngine into PyQtWebEngine

← Older revision		Revision as of 20:47, 1 March 2019
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}}

imported>Leoetlino: whoops. GPLv3 -> GPLv2+

2018-10-21T14:55:49Z

whoops. GPLv3 -> GPLv2+

← Older revision		Revision as of 14:55, 21 October 2018
Line 5:		Line 5:
	\| authors = leoetlino		\| authors = leoetlino
	\| source = https://github.com/leoetlino/event-editor		\| source = https://github.com/leoetlino/event-editor
	\| license = ~~GPLv3~~		\| license = GPLv2+
	\| written_in = Python		\| written_in = Python
	\| win_only =		\| win_only =

imported>Leoetlino: /* Enabling auto completion support */

2018-10-21T08:22:21Z

Enabling auto completion support

← Older revision		Revision as of 08:22, 21 October 2018
Line 36:		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:~~Setting up~~ botwfstools\|botwfstools]].''		''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 ==

imported>Leoetlino at 07:57, 21 October 2018

2018-10-21T07:57:50Z

← Older revision		Revision as of 07:57, 21 October 2018
Line 19:		Line 19:
	# 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 ==

imported>Leoetlino at 11:50, 20 October 2018

2018-10-20T11:50:07Z

← Older revision		Revision as of 11:50, 20 October 2018
Line 9:		Line 9:
	\| win_only =		\| win_only =
	}}		}}

			EventEditor is a graphical editor for [[event flow]]s. It can currently only handle event flowcharts; event timelines are not supported yet.

	== Setup ==		== Setup ==
Line 37:		Line 39:
	* On Linux or macOS: at <code>~/.config/eventeditor/eventeditor.ini</code>		* On Linux or macOS: at <code>~/.config/eventeditor/eventeditor.ini</code>
	* 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.

imported>Leoetlino: Leoetlino moved page Help:Setting up tools/EventEditor to Help:Tools/EventEditor

2018-10-20T11:42:14Z

Leoetlino moved page Help:Tools/EventEditor to Help:Tools/EventEditor

← Older revision	Revision as of 11:42, 20 October 2018
(No difference)

imported>Leoetlino at 11:41, 20 October 2018

2018-10-20T11:41:56Z

← Older revision		Revision as of 11:41, 20 October 2018
Line 1:		Line 1:
	== ~~Prerequisites~~ ==		[[Category:Tools]]
	~~Ensure you have a '''64 bit version''' of~~ Python ~~3.'''6+''' before continuing. You will not be able to install or launch EventEditor otherwise.~~		[[Category:Tools (BFEVFL)]]
			{{Tool infobox
			\| name = EventEditor
			\| authors = leoetlino
			\| source = https://github.com/leoetlino/event-editor
			\| license = GPLv3
			\| written_in = Python
			\| win_only =
			}}

	~~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~~.		== 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.
	~~== Installing ==~~
	# 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>.
Line 30:		Line 37:
	* On Linux or macOS: at <code>~/.config/eventeditor/eventeditor.ini</code>		* On Linux or macOS: at <code>~/.config/eventeditor/eventeditor.ini</code>
	* On Windows: at <code>%APPDATA%/eventeditor/eventeditor.ini</code>		* On Windows: at <code>%APPDATA%/eventeditor/eventeditor.ini</code>

	~~[[Category: Guides]]~~
	~~[[Category: Guides (tools)]]~~

imported>Leoetlino: /* Enabling auto completion support */

2018-09-30T14:44:59Z

Enabling auto completion support

← Older revision		Revision as of 14:44, 30 September 2018
Line 24:		Line 24:
	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]].''		''An easy, recommended way to get the required file structure without having to extract every single archive is to use [[Help:Setting up botwfstools\|botwfstools]].''

	== Configuration file ==		== Configuration file ==

imported>Leoetlino at 19:23, 18 September 2018

2018-09-18T19:23:14Z

← Older revision		Revision as of 19:23, 18 September 2018
Line 1:		Line 1:
			== 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 ==		== Installing ==
	~~Important: ensure~~ you ~~have a~~ '~~''64 bit version''' of Python 3~~.~~'''6+''' before continuing~~. You will ~~not be able~~ to install ~~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>.
	# ~~Install PyQt5. (~~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}}
	# Install the <code>eventeditor</code> package. {{Install py package help\|package=eventeditor}}		# Install the <code>eventeditor</code> package. {{Install py package help\|package=eventeditor}}