Design Document Game Boxes - Revision history

Rich: /* Tile Orientation */

2018-12-21T15:52:43Z

Tile Orientation

← Older revision		Revision as of 15:52, 21 December 2018
Line 15:		Line 15:
	in the other orientation as "Flat Side Up" or Type F map boards.		in the other orientation as "Flat Side Up" or Type F map boards.

	'''[[Type_%22F%22_Board_Map_Glitch\|<span style="color: Green">This note</span>]] describes a potential problem with some Type F ~~board maps~~.'''		'''[[Type_%22F%22_Board_Map_Glitch\|<span style="color: Green">This note</span>]] describes a potential problem with some Type F map boards.'''

	=== Size Standards===		=== Size Standards===

Rich: /* Tile Orientation */ added note

2018-12-21T15:51:12Z

Tile Orientation: added note

← Older revision		Revision as of 15:51, 21 December 2018
Line 5:		Line 5:
	=== Tile Orientation ===		=== Tile Orientation ===

	[[File:Hexdim.png\|frame]] ~~Most~~ 18xx game boards ~~have~~ a hex grid orientated with the		[[File:Hexdim.png\|frame]]
			Historically most 18xx game boards had a hex grid orientated with the
	points of the hexes facing North and South as is shown in the diagram to the right.		points of the hexes facing North and South as is shown in the diagram to the right.
	But a number of game boards have a hex grid orientation that is rotated 30 degrees		But a number of game boards [especially newer ones] have a hex grid orientation that is rotated 30 degrees
	from this ~~more common~~ orientation. BOARD18 can handle both orientations.		from this orientation. BOARD18 can handle both orientations.

	This document will refer to map boards in the first orientation as "Point Up" or		This document will refer to map boards in the first orientation as "Point Up" or
	Type P map boards. And it will refer to map boards		Type P map boards. And it will refer to map boards
	in the other orientation as "Flat Side Up" or Type F map boards.		in the other orientation as "Flat Side Up" or Type F map boards.

			'''[[Type_%22F%22_Board_Map_Glitch\|<span style="color: Green">This note</span>]] describes a potential problem with some Type F board maps.'''

	=== Size Standards===		=== Size Standards===

Rich: removed The JSON Game Session Data Structure

2018-02-20T22:12:52Z

removed The JSON Game Session Data Structure

← Older revision		Revision as of 22:12, 20 February 2018
Line 87:		Line 87:

	The data structure in the game box JSON file with the key of '''links''' defines the HTTP links associated with the game box.		The data structure in the game box JSON file with the key of '''links''' defines the HTTP links associated with the game box.
	It is an array of data structures each of which describes a link		It is an array of data structures each of which describes a link to a useful file that is associated with the game box.
	to a useful file that is associated with the game box.

	~~=== The JSON Game Session Data Structure===~~

	Each game session has its own JSON data structure. The '''gname''', and '''boxID''' keys are used to identify the JSON Game Session and specify the game box that the game session uses. These are followed by four array structures.

	The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.

	~~The following is a depiction of the top levels of this data structure:~~
	~~<pre>~~
	{
	~~"gname":"The Name of the Game",~~
	~~"boxID":"The numeric ID of the Game Box",~~
	~~"brdTls": {~~

	},
	~~"brdTks": {~~

	},
	~~"mktTks": [~~

	],
	~~"trayCounts": [~~

	]
	}
	~~</pre>~~

	[[Category:Design]]		[[Category:Design]]

Rich: updated release notice

2017-07-31T23:41:57Z

updated release notice

← Older revision		Revision as of 23:41, 31 July 2017
Line 1:		Line 1:
	{{ReleaseNotice\|2.1}}{{Design Document Index}}		{{ReleaseNotice\|2.5}}{{Design Document Index}}
	BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools are then packaged and uploaded to the BOARD18 server. This upload is accomplished via a built-in administrative facility.		BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools are then packaged and uploaded to the BOARD18 server. This upload is accomplished via a built-in administrative facility.
	{{Game Box Index}}		{{Game Box Index}}

Rich at 23:40, 31 July 2017

2017-07-31T23:40:05Z

← Older revision		Revision as of 23:40, 31 July 2017
Line 1:		Line 1:
	{{ReleaseNotice\|2.1}}{{Design Document Index}}		{{ReleaseNotice\|2.1}}{{Design Document Index}}
	BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools are then packaged and uploaded to the BOARD18 server. This upload ~~can be~~ accomplished via a built-in ~~and automatic process~~.~~<br>'''[[Game Boxes\|<span style="color: Green">A game box list can be found here.</span>]]'''~~		BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools are then packaged and uploaded to the BOARD18 server. This upload is accomplished via a built-in administrative facility.
	{{Game Box Index}}		{{Game Box Index}}
	== Graphics Standards==		== Graphics Standards==

Rich: /* The JSON Game Session Data Structure */

2016-10-30T14:57:26Z

The JSON Game Session Data Structure

← Older revision		Revision as of 14:57, 30 October 2016
Line 96:		Line 96:
	The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.		The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.

	The following is a depiction of the top levels of this data structure"		The following is a depiction of the top levels of this data structure:
	<pre>		<pre>
	{		{

Rich: /* The JSON Game Session Data Structure */ added top level depiction

2016-10-30T14:56:53Z

The JSON Game Session Data Structure: added top level depiction

← Older revision		Revision as of 14:56, 30 October 2016
Line 95:		Line 95:

	The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.		The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.

			The following is a depiction of the top levels of this data structure"
			<pre>
			{
			"gname":"The Name of the Game",
			"boxID":"The numeric ID of the Game Box",
			"brdTls": {

			},
			"brdTks": {

			},
			"mktTks": [

			],
			"trayCounts": [

			]
			}
			</pre>

	[[Category:Design]]		[[Category:Design]]

Rich: bring introduction up to date

2016-07-05T16:02:24Z

bring introduction up to date

← Older revision		Revision as of 16:02, 5 July 2016
Line 1:		Line 1:
	{{ReleaseNotice\|2.1}}{{Design Document Index}}		{{ReleaseNotice\|2.1}}{{Design Document Index}}
	BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools ~~can~~ then be uploaded to the BOARD18 server. This upload ~~should eventually~~ be accomplished via a built-in and automatic process.<br>'''[[Game Boxes\|<span style="color: Green">A game box list can be found here.</span>]]'''		BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools are then packaged and uploaded to the BOARD18 server. This upload can be accomplished via a built-in and automatic process.<br>'''[[Game Boxes\|<span style="color: Green">A game box list can be found here.</span>]]'''
	{{Game Box Index}}		{{Game Box Index}}
	== Graphics Standards==		== Graphics Standards==

Rich at 14:41, 3 June 2016

2016-06-03T14:41:38Z

← Older revision		Revision as of 14:41, 3 June 2016
Line 83:		Line 83:

	The sheets with a type value of '''mtok''' are market token sheets. A market token sheet is the same as a board token sheet with one exception. The '''token''' key defines an array of values (one for each token) that specify only whether the token can be flipped. There is no 'number of duplicates' field for '''mtok'''.		The sheets with a type value of '''mtok''' are market token sheets. A market token sheet is the same as a board token sheet with one exception. The '''token''' key defines an array of values (one for each token) that specify only whether the token can be flipped. There is no 'number of duplicates' field for '''mtok'''.

			=== The JSON Links Data Structure===

			The data structure in the game box JSON file with the key of '''links''' defines the HTTP links associated with the game box.
			It is an array of data structures each of which describes a link
			to a useful file that is associated with the game box.

	=== The JSON Game Session Data Structure===		=== The JSON Game Session Data Structure===
Line 89:		Line 95:

	The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.		The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.

	~~=== The JSON Links Data Structure===~~

	~~The data structure in the game box JSON file with the key of '''links''' defines the HTTP links associated with the game box.~~
	~~It is an array of data structures each of which describes a link~~
	~~to a useful file that is associated with the game box.~~

	[[Category:Design]]		[[Category:Design]]

Rich: added links data structure

2016-06-03T14:39:17Z

added links data structure

← Older revision		Revision as of 14:39, 3 June 2016
Line 1:		Line 1:
	{{~~Design Document Index~~}}		{{ReleaseNotice\|2.1}}{{Design Document Index}}
	{{~~ReleaseNotice\|1.3~~}}
	BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools can then be uploaded to the BOARD18 server. This upload should eventually be accomplished via a built-in and automatic process.<br>'''[[Game Boxes\|<span style="color: Green">A game box list can be found here.</span>]]'''		BOARD18 can be used to play any [http://en.wikipedia.org/wiki/18xx 18xx style game] for which a game box exists. A game box consists of the graphics files and control tables that describe the game board, the stock market and the various playing pieces. A game box is built using a graphics editor (such as GIMP) and a text editor. The files created with these tools can then be uploaded to the BOARD18 server. This upload should eventually be accomplished via a built-in and automatic process.<br>'''[[Game Boxes\|<span style="color: Green">A game box list can be found here.</span>]]'''
	{{Game Box Index}}		{{Game Box Index}}
Line 90:		Line 89:

	The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.		The array with the key of '''brdTls''' tracks the tiles that have been placed on the board. The array with the key of '''brdTks''' tracks the tokens that have been placed on the board. The array with the key of '''mktTks''' tracks the tokens that have been placed on the stock market. And the array with the key of '''trayCounts''' tracks the number of remaining tiles and tokens available to be played on the game board.

			=== The JSON Links Data Structure===

			The data structure in the game box JSON file with the key of '''links''' defines the HTTP links associated with the game box.
			It is an array of data structures each of which describes a link
			to a useful file that is associated with the game box.

	[[Category:Design]]		[[Category:Design]]