Cockpit Tutorial - Revision history

Cadillac at 02:12, 23 August 2021

2021-08-23T02:12:09Z

← Older revision		Revision as of 21:12, 22 August 2021
Line 526:		Line 526:
	For testing your cockpit, see [[Testing Resources]]. You can make your work available to others by uploading it to the [[Resource repository]]. If you do that, you might want to add an entry to [[Cockpits list]] to tell users about your cockpit.		For testing your cockpit, see [[Testing Resources]]. You can make your work available to others by uploading it to the [[Resource repository]]. If you do that, you might want to add an entry to [[Cockpits list]] to tell users about your cockpit.

	[[Category:~~Client Features~~]]		[[Category:Customization]]

Ninja Potato: /* Special Values */ Updated options

2020-11-02T23:09:50Z

Special Values: Updated options

← Older revision		Revision as of 18:09, 2 November 2020
Line 125:		Line 125:
	\|-		\|-
	\| top_score \|\| The highest score.		\| top_score \|\| The highest score.
			\|-
			\| top_other_score \|\| The highest score other than the currently watched cycle.
			\|-
			\| current_score_team \|\| The team score of the currently watched cycle.
			\|-
			\| top_score_team \|\| The highest team score.
			\|-
			\| top_other_score_team \|\| The highest team score other than the currently watched cycle.
	\|-		\|-
	\| fastest_speed \|\| The speed of the fastest cycle.		\| fastest_speed \|\| The speed of the fastest cycle.

Titanoboa: /* Overview of the Cockpit file */ fixed a typo

2020-10-26T17:51:04Z

Overview of the Cockpit file: fixed a typo

← Older revision		Revision as of 12:51, 26 October 2020
Line 19:		Line 19:
	In the Cockpit section you'll find a series of widget tags that contain data tags to hook the widget into some game data. There's a caption, some position and size parameters, and so forth. You can also specify background and foreground colors, with gradiants, and with graphics, to provide a really custom gauge. Additionally, widgets can be associated with a camera, or made for all cameras, with the option of excluding specific cameras, offering the possibility to give a completely custom view for each camera you use. All of this gets mixed together and rendered to screen as your cockpit.		In the Cockpit section you'll find a series of widget tags that contain data tags to hook the widget into some game data. There's a caption, some position and size parameters, and so forth. You can also specify background and foreground colors, with gradiants, and with graphics, to provide a really custom gauge. Additionally, widgets can be associated with a camera, or made for all cameras, with the option of excluding specific cameras, offering the possibility to give a completely custom view for each camera you use. All of this gets mixed together and rendered to screen as your cockpit.

	A complete gauge, in concept, isn't ~~necessary~~ a single widget in the cockpit file. As an example, you might want to build a "Performance" gauge that includes ping, frames per second, cpu usage, overall system load, and bandwidth usage. That would require placing several widgets together, stacked on top of each other or on each other's sides, to build the conceptual Performance gauge you intend. Here, we'll use "gauge" to refer to a specific gauge and "widget" to refer to the larger conceptual gauge. Most widgets that you'll build will just be gauges, so it's not a big deal. (Note: At the time of writing, all of the data in the hypothetical Performance gauge isn't available to the cockpit, but the system is easily extensible and there's no reason to think it will never be available)		A complete gauge, in concept, isn't necessarily a single widget in the cockpit file. As an example, you might want to build a "Performance" gauge that includes ping, frames per second, cpu usage, overall system load, and bandwidth usage. That would require placing several widgets together, stacked on top of each other or on each other's sides, to build the conceptual Performance gauge you intend. Here, we'll use "gauge" to refer to a specific gauge and "widget" to refer to the larger conceptual gauge. Most widgets that you'll build will just be gauges, so it's not a big deal. (Note: At the time of writing, all of the data in the hypothetical Performance gauge isn't available to the cockpit, but the system is easily extensible and there's no reason to think it will never be available)

	Within each gauge there are a series of tags that are used to define what it looks like, what data it uses, and so forth. The tags that are available vary from gauge to gauge, but the meaning of each tag never varies. Two gauges that are diametrically opposite to each other might interpret the tag differently, but it will still mean the same thing for both gauges. That's an important subtlety that you should keep in mind.		Within each gauge there are a series of tags that are used to define what it looks like, what data it uses, and so forth. The tags that are available vary from gauge to gauge, but the meaning of each tag never varies. Two gauges that are diametrically opposite to each other might interpret the tag differently, but it will still mean the same thing for both gauges. That's an important subtlety that you should keep in mind.

Epsy: Add the cockpits blurb

2013-01-16T23:37:59Z

Add the cockpits blurb

← Older revision		Revision as of 18:37, 16 January 2013
Line 1:		Line 1:
			{{Cockpits Blurb}}

	This document describes canonically how to create a cockpit resource file. Hopefully it'll be easy to read, too.		This document describes canonically how to create a cockpit resource file. Hopefully it'll be easy to read, too.

Nux: /* Special Values */ Added note to current_ping being required to be set for all viewports as its a common question/issue

2012-05-16T22:55:49Z

Special Values: Added note to current_ping being required to be set for all viewports as its a common question/issue

← Older revision		Revision as of 17:55, 16 May 2012
Line 94:		Line 94:
	\| player_rubber \|\| The rubber that's used for the player currently being watched. Ranges from 0 to CYCLE_RUBBER.		\| player_rubber \|\| The rubber that's used for the player currently being watched. Ranges from 0 to CYCLE_RUBBER.
	\|-		\|-
	\| current_ping \|\| The ping time in milliseconds for the client.		\| current_ping \|\| The ping time in milliseconds for the client. Note, in order for this to work, it needs to be assigned to all viewports, ie: viewport="all".
	\|-		\|-
	\| player_speed \|\| The speed of the cycle currently being watched.		\| player_speed \|\| The speed of the cycle currently being watched.

Wrtlprnft: /* Textures */ updated to match latest code changes

2008-02-13T23:07:50Z

Textures: updated to match latest code changes

← Older revision		Revision as of 18:07, 13 February 2008
Line 234:		Line 234:
	:Can be one of <code>none</code>, <code>x</code>, <code>y</code> or <code>both</code>. This specifies in which directions the texture will repeat itself. The area not covered by the image will be filled by the last row/column of the texture. Usually you'll want <code>both</code>, so this is the default.		:Can be one of <code>none</code>, <code>x</code>, <code>y</code> or <code>both</code>. This specifies in which directions the texture will repeat itself. The area not covered by the image will be filled by the last row/column of the texture. Usually you'll want <code>both</code>, so this is the default.

	The <code><Graphic /></code> tag contains information on where to find the texture. The attrubutes <code>author</code> (default: ~~<code>Anonymous</code>~~), <code>category</code> (default: ~~<code>unsorted</code>~~), <code>name</code>, <code>version</code> and <code>extension</code> (default: <code>png</code>) specify the resource path of the texture, <code><author>/<category>/<name>-<version>.<aatex>.<extension></code>. If the attribute <code>uri</code> is given the file will be downloaded from the given URI instead of the resource repository if it's not already cached.		The <code><Graphic /></code> tag contains information on where to find the texture. The attrubutes <code>author</code> (default: the author of the cockpit), <code>category</code> (default:the category of the cockpit), <code>name</code>, <code>version</code> and <code>extension</code> (default: <code>png</code>) specify the resource path of the texture, <code><author>/<category>/<name>-<version>.<aatex>.<extension></code>. If the attribute <code>uri</code> is given the file will be downloaded from the given URI instead of the resource repository if it's not already cached.

	If there's a <code><Color /></code> or <code><Gradient /></code> tag after the <code><Image /></code> tag the color at each pixel of the texture will be multiplied by the color at the corresponding point of the gradient (or the single color given). In the example this is used to make a semitransparent background image.		If there's a <code><Color /></code> or <code><Gradient /></code> tag after the <code><Image /></code> tag the color at each pixel of the texture will be multiplied by the color at the corresponding point of the gradient (or the single color given). In the example this is used to make a semitransparent background image.

Wrtlprnft: /* Layers */ documentaion for textures

2008-02-12T22:38:16Z

Layers: documentaion for textures

← Older revision		Revision as of 17:38, 12 February 2008
Line 211:		Line 211:

	: There are three different types of gradients, indicated by the orientation attribute. Possible values are "horizontal" and "vertical" which will make horizontal or vertical gradients. A special value is "value" which will result in a solid area which changes color according to the value of the displayed data. The color with at="0" will be used at the minimum value and at="1" will be used at the maximum.		: There are three different types of gradients, indicated by the orientation attribute. Possible values are "horizontal" and "vertical" which will make horizontal or vertical gradients. A special value is "value" which will result in a solid area which changes color according to the value of the displayed data. The color with at="0" will be used at the minimum value and at="1" will be used at the maximum.

			==== Textures ====

			There's some basic support for textures in recent builds. A texture can be added to any <code><Foreground /></code>/<code><Background /></code> tag, either instead or before the color or even gradient. Although you can specify a texture for all gauges that support foregrounds/backgrounds they only make sense for widgets that render more than just lines :-)

			Here's an example of a working texture:

			<Background>
			<Image scale_x="1" scale_y="1" repeat="both">
			<Graphic category="" author="wrtlprnft" version="1" name="wood_512" extension="jpg" uri="http://wrtlprnft.ath.cx/wood512.jpg" />
			</Image>
			<Solid>
			<Color r="1." g="1." b="1." alpha=".5" />
			</Solid>
			</Background>

			The <code><Image /></code> tag supports the following attributes:

			;<code>scale_x</code>/<code>scale_y</</code>
			:The scale factor for the texture. If both are set to <code>1</code> the texture is stretched so it covers the entire area of the widget.
			;<code>repeat</code>
			:Can be one of <code>none</code>, <code>x</code>, <code>y</code> or <code>both</code>. This specifies in which directions the texture will repeat itself. The area not covered by the image will be filled by the last row/column of the texture. Usually you'll want <code>both</code>, so this is the default.

			The <code><Graphic /></code> tag contains information on where to find the texture. The attrubutes <code>author</code> (default: <code>Anonymous</code>), <code>category</code> (default: <code>unsorted</code>), <code>name</code>, <code>version</code> and <code>extension</code> (default: <code>png</code>) specify the resource path of the texture, <code><author>/<category>/<name>-<version>.<aatex>.<extension></code>. If the attribute <code>uri</code> is given the file will be downloaded from the given URI instead of the resource repository if it's not already cached.

			If there's a <code><Color /></code> or <code><Gradient /></code> tag after the <code><Image /></code> tag the color at each pixel of the texture will be multiplied by the color at the corresponding point of the gradient (or the single color given). In the example this is used to make a semitransparent background image.

			'''General advice on textures''': Make sure the dimensions of every image you want are in powers of two, for example 64×64, 256×256, 512×512 or 1024×1024. Rectangular images are OK, too, so you can use 32×1024 images, too, if you really want to. Images of other dimensions will be scaled to be powers of two by OpenGL, which doesn't excactly lead to pretty results.

	== Available Gauges ==		== Available Gauges ==

Wrtlprnft: /* Map */ Documented the new tag

2006-12-02T16:52:36Z

Map: Documented the new <MapModes /> tag

@@ Line 372: / Line 372: @@
      <Map camera="*" viewport="top">
          <Position x="0.73" y="-0.72" />
-            <Size height="0.25" width="0.25" />
+        <Size height="0.25" width="0.25" />
      </Map>
 == Gauge Templates ==

Wrtlprnft: Linked to an old version that shows what's implemented in 0.3.0

2006-12-02T16:38:31Z

Linked to an old version that shows what's implemented in 0.3.0

← Older revision		Revision as of 11:38, 2 December 2006
Line 1:		Line 1:
	This document describes canonically how to create a cockpit resource file. Hopefully it'll be easy to read, too.		This document describes canonically how to create a cockpit resource file. Hopefully it'll be easy to read, too.

	'''This is only implemented in the ~~0.3~~ development ~~snapshots, not in actual releases~~. ~~For already existing projects see~~ [~~[Cockpits list]~~].'''		'''This is only fully implemented in the latest unreleased development versions. There's a [http://wiki.armagetronad.net/index.php?title=Cockpit_Tutorial&oldid=15841 snapshot of this article] that describes the features implemented in 0.3.0'''

	== A Cockpit—The Concept ==		== A Cockpit—The Concept ==

Wrtlprnft: /* Construction of a Gauge */ added the new “cycle” value for the “viewport” attribute.

2006-11-21T15:55:12Z

Construction of a Gauge: added the new “cycle” value for the “viewport” attribute.

← Older revision		Revision as of 10:55, 21 November 2006
Line 46:		Line 46:
	* <code>camera="^all"</code>—Never show, kinda pointless.		* <code>camera="^all"</code>—Never show, kinda pointless.

	Finally all gauges support the <code>viewport</code> attribute. Possible values are ~~"top"~~ and ~~"all"~~, the latter being the default. ~~"top"~~ means that the widget will be rendered on top of the screen, ~~"all"~~ means it will be rendered for every player in multiplayer mode. Some data sources are only available in ~~"all"~~ mode, but you might not want a separate map for each player, so choose ~~"top"~~ then.		Finally all gauges support the <code>viewport</code> attribute. Possible values are “top”, “cycle” and “all”, the latter being the default. “top” means that the widget will be rendered on top of the screen, “all” means it will be rendered for every player in multiplayer mode. Some data sources are only available in “all” mode, but you might not want a separate map for each player, so choose “top” then.

			“cycle” is a special viewport, it means that the widget will be rendered over every cycle, just like the label (name). The orign of the coordinate system will be right above the centre of the label in this case.

	== General Gauge Information ==		== General Gauge Information ==