Tools - Revision history

Phil: /* Controls & Key Shortcuts */

2024-10-07T21:25:22Z

Controls & Key Shortcuts

← Older revision		Revision as of 21:25, 7 October 2024
Line 29:		Line 29:
	ENTER - reset camera position		ENTER - reset camera position
	I - toggle info display		I - toggle info display
			R - attempt to rotate the _1turret object. SHIFT+R to cancel
			C - do a camera reset to show the full object, also removes the info cube
			SPACE - toggle light between global and camera
			F1 - reload the shaders
			A - toggle playing of animations

	LMB - hold to rotate camera		LMB - hold to rotate camera

Phil: /* CONFIG.TXT */

2024-10-07T21:22:20Z

CONFIG.TXT

← Older revision		Revision as of 21:22, 7 October 2024
Line 36:		Line 36:
	You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.		You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.

	<~~nowiki~~>		<pre>
	// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.		// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.
	COREPATH D:\BUILDS\BUILD1\		COREPATH D:\BUILDS\BUILD1\
Line 58:		Line 58:
	PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES		PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES
	PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>		PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>
	</~~nowiki~~>		</pre>

Phil: /* CONFIG.TXT */

2024-10-07T21:21:40Z

CONFIG.TXT

← Older revision		Revision as of 21:21, 7 October 2024
Line 36:		Line 36:
	You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.		You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.

	<~~code~~>		<nowiki>
	// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.		// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.
	COREPATH D:\BUILDS\BUILD1\		COREPATH D:\BUILDS\BUILD1\
Line 58:		Line 58:
	PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES		PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES
	PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>		PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>
	</~~code~~>		</nowiki>

Phil: /* CONFIG.TXT */

2024-10-07T21:21:19Z

CONFIG.TXT

← Older revision		Revision as of 21:21, 7 October 2024
Line 35:		Line 35:
	===CONFIG.TXT===		===CONFIG.TXT===
	You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.		You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.
	<~~nowiki~~>
			<code>
	// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.		// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.
	COREPATH D:\BUILDS\BUILD1\		COREPATH D:\BUILDS\BUILD1\
Line 57:		Line 58:
	PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES		PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES
	PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>		PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>
			</code>

Phil: /* CONFIG.TXT */

2024-10-07T21:19:29Z

CONFIG.TXT

← Older revision		Revision as of 21:19, 7 October 2024
Line 35:		Line 35:
	===CONFIG.TXT===		===CONFIG.TXT===
	You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.		You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.
	<nowiki>// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.		<nowiki>
			// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.
	COREPATH D:\BUILDS\BUILD1\		COREPATH D:\BUILDS\BUILD1\
	// FXPATH points to the folder containing the textures used by the particles		// FXPATH points to the folder containing the textures used by the particles
	FXPATH D:\BUILDS\BUILD1\CORE		FXPATH D:\BUILDS\BUILD1\CORE

			// if the mesh has an animation file, select this animation to loop on load, if it exists
			DEFAULTANIM <anim name>

			// define the % of the screen width used by the righthand tool bar (defaults to 12%)
			TOOLBARPERC <percentage>

			// background colour
			BACKCOLOUR <colour in hex>

			// the size of the info cube (default is 1)
			CUBESIZE <size as float>

	// TEXTURES chunk can contain one or more paths, which are searched in order, for textures to load for any meshes which are loaded into the tool		// TEXTURES chunk can contain one or more paths, which are searched in order, for textures to load for any meshes which are loaded into the tool
Line 45:		Line 58:
	PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>		PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>

	~~// if the mesh has an animation file, select this animation to loop on load, if it exists~~
	~~DEFAULTANIM <anim name>~~

Phil: /* CONFIG.TXT */

2018-08-28T18:02:26Z

CONFIG.TXT

← Older revision		Revision as of 18:02, 28 August 2018
Line 44:		Line 44:
	PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES		PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES
	PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>		PATH D:\BUILDS\BUILD1\DATA\UI\TEXTURES</nowiki>

			// if the mesh has an animation file, select this animation to loop on load, if it exists
			DEFAULTANIM <anim name>

Phil: /* CONFIG.TXT */

2016-11-28T16:59:11Z

CONFIG.TXT

← Older revision		Revision as of 16:59, 28 November 2016
Line 34:		Line 34:

	===CONFIG.TXT===		===CONFIG.TXT===
	You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths.		You can set up texture paths for the particles as well as loaded meshes. This has a similar layout to the config file for the import tool. Below is an example, obviously using example paths. Note that all entries (and, indeed, the entire config file) are optional.
	<nowiki>// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.		<nowiki>// COREPATH points to the path where the CORE folder containing the SHADERS folder is. Note the trailing slash.
	COREPATH D:\BUILDS\BUILD1\		COREPATH D:\BUILDS\BUILD1\
	// FXPATH ~~(optional)~~ points to the folder containing the textures used by the particles		// FXPATH points to the folder containing the textures used by the particles
	FXPATH D:\BUILDS\BUILD1\CORE		FXPATH D:\BUILDS\BUILD1\CORE

	// TEXTURES chunk can contain one or more paths, which are searched in order, for ~~texture~~ to load for any meshes which are loaded into the tool		// TEXTURES chunk can contain one or more paths, which are searched in order, for textures to load for any meshes which are loaded into the tool
	[TEXTURES]		[TEXTURES]
	PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES		PATH D:\BUILDS\BUILD1\DATA\BATTLE\UNITTEXTURES

Phil: /* Particle Tool */

2016-11-28T16:58:15Z

Particle Tool

@@ Line 19: / Line 19: @@
 ====Fixed and Fixed Local====
 Fixed particles will remain with the emitter frame they are associated with.  An example would be a glowing sword.  Setting a stationary particle to fixed would cause it sit on the surface of the sword mesh even as the mesh moved around under animation.  Fixed Local controls how particle movement happens when Fixed is enabled.  When off particles will remain in the frame of reference of their emitter frame.  So in this case, if we change the particles to move in the Y direction then with Fixed Local off the particles would remain in the same positions relative to the sword (so lifting the sword would cause them to move up and stick out like a flag).  Turning in on means that the particles would be positioned along the Y axis relative to their original emission point, no matter the orientation of the sword (e.g. could fall down along the blade and onto the hilt if the sword was raised).
 [ detailed docs TBD ]

Phil: /* Particle Tool */

2016-09-02T17:47:48Z

Particle Tool

← Older revision		Revision as of 17:47, 2 September 2016
Line 9:		Line 9:
	This describes individual particles, and how they change over their lifetime. You can set the lifespan of a particle and how its speed, appearance, etc change. Particles have a maximum lifespan of 255 ticks (so about 8.5 seconds). Editing of the particle attributes is done via sliders or curves, depending upon the type of parameter.		This describes individual particles, and how they change over their lifetime. You can set the lifespan of a particle and how its speed, appearance, etc change. Particles have a maximum lifespan of 255 ticks (so about 8.5 seconds). Editing of the particle attributes is done via sliders or curves, depending upon the type of parameter.
	====Emitters====		====Emitters====
	And emitter defines which particles are emitted from given points on a model. The points are identified by an index which is extracted from special naming of model frames (e.g. !3 denotes this frame is emitter index 3). You can ~~use~~ these points by emitting from the position of an emitter frame, along a line between two emitter frames, or you can emiter particles randomly from the surface of the emitter frame (assuming it has a mesh associated with it). You turn on mesh emission by clicking down the second emitter frame index below zero so it denotes mesh emission.		And emitter defines which particles are emitted from given points on a model. The points are identified by an index which is extracted from special naming of model frames (e.g. !3 denotes this frame is emitter index 3). You can utilise these points by emitting from the position of an emitter frame, along a line between two emitter frames, or you can emiter particles randomly from the surface of the emitter frame (assuming it has a mesh associated with it). You turn on mesh emission by clicking down the second emitter frame index below zero so it denotes mesh emission.
	====Effects====		====Effects====
	An effect is a set of emitters which can (optionally) be turned on and off during playback via the timings dialog. The game can trigger effects using the animation and scripting systems.		An effect is a set of emitters which can (optionally) be turned on and off during playback via the timings dialog. The game can trigger effects using the animation and scripting systems.

	===Coordinate Types===		===Coordinate Types===
	The checkboxes above the particle attribute area control how particles are emitted and move relative to their emission frame.		The checkboxes above the particle attribute area control how particles are emitted and move relative to their emitter frame.
			====World====
			If this is checked then the particles with be emitted in world coordinates, irrespective of the orientation of the emitter frame. So, if a particle is set to travel in the Y direction and this is unchecked, it will emit in the direction of the Y axis of its emitter frame (e.g. if the frame is animated, the direction of emission will change). If this box is checked then it will emit along the Y axis (so directly up or down) no matter the orientation of the emitter frame.
			====Fixed and Fixed Local====
			Fixed particles will remain with the emitter frame they are associated with. An example would be a glowing sword. Setting a stationary particle to fixed would cause it sit on the surface of the sword mesh even as the mesh moved around under animation. Fixed Local controls how particle movement happens when Fixed is enabled. When off particles will remain in the frame of reference of their emitter frame. So in this case, if we change the particles to move in the Y direction then with Fixed Local off the particles would remain in the same positions relative to the sword (so lifting the sword would cause them to move up and stick out like a flag). Turning in on means that the particles would be positioned along the Y axis relative to their original emission point, no matter the orientation of the sword (e.g. could fall down along the blade and onto the hilt if the sword was raised).

	[ detailed docs TBD ]		[ detailed docs TBD ]

Phil: /* Particle Tool */

2016-09-02T17:36:33Z

Particle Tool

@@ Line 3: / Line 3: @@
 == Particle Tool ==
 The particle tool allows for the creation of FXF files.
 [ detailed docs TBD ]