Game Box Creation - Control File Semantics - Revision history

Rich: /* Box Descriptor Values */

2020-09-24T15:16:05Z

Box Descriptor Values

← Older revision		Revision as of 15:16, 24 September 2020
Line 13:		Line 13:

	Please do not use any of the following 4 characters (+ & = ~) as part of any of these 3 fields.<br>		Please do not use any of the following 4 characters (+ & = ~) as part of any of these 3 fields.<br>
	~~They~~ can cause issues with HTTP GET formatting in some of the Administrative utilities.		These characters can cause issues with HTTP GET formatting in some of the Administrative utilities.

	===Image Location Value===		===Image Location Value===

Rich: /* Box Descriptor Values */ added special character note.

2020-09-24T15:15:22Z

Box Descriptor Values: added special character note.

← Older revision		Revision as of 15:15, 24 September 2020
Line 11:		Line 11:
	# "version": I use my initials combined with a sequential number. EG: "REP01"		# "version": I use my initials combined with a sequential number. EG: "REP01"
	# "author": your name. EG: "Rich Price"		# "author": your name. EG: "Rich Price"

			Please do not use any of the following 4 characters (+ & = ~) as part of any of these 3 fields.<br>
			They can cause issues with HTTP GET formatting in some of the Administrative utilities.

	===Image Location Value===		===Image Location Value===
	Each image has an "imgLoc" value that specifies the relative location of the image file. For the provided directory structure this will always have this form "images/nnnn/file.png" where nnnn is the game name and file.png is the name of the image file.		Each image has an "imgLoc" value that specifies the relative location of the image file. For the provided directory structure this will always have this form "images/nnnn/file.png" where nnnn is the game name and file.png is the name of the image file.

Rich: /* Orientation Value */ added note

2020-05-21T20:36:10Z

Orientation Value: added note

← Older revision		Revision as of 20:36, 21 May 2020
Line 20:		Line 20:
	The "orientation" value in the "board" object will be set to either "P" or "F" to indicate the orientation of the map board's hex grid. <br>		The "orientation" value in the "board" object will be set to either "P" or "F" to indicate the orientation of the map board's hex grid. <br>
	For backward compatibility a missing "orientation" value will default to "P".		For backward compatibility a missing "orientation" value will default to "P".

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

	===Tray Values===		===Tray Values===

Rich: /* Orientation Value */

2020-05-21T20:34:18Z

Orientation Value

← Older revision		Revision as of 20:34, 21 May 2020
Line 15:		Line 15:

	===Orientation Value===		===Orientation Value===
	The hex grid on the map board will either be in "Point Up" orientation or in "Flat Side Up" orientation. Map boards that are in "Point Up" orientation will be referred to as Type P map boards. Map boards that are in "Flat Side Up" orientation will be referred to as Type F map boards.		The hex grid on the map board will either be in "Point Up" orientation or in "Flat Side Up" orientation. <br>
	<br>The "orientation" value in the "board" object will be set to either "P" or "F" to indicate the orientation of the map board's hex grid. For backward compatibility a missing "orientation" value will default to "P".		Map boards that are in "Point Up" orientation will be referred to as Type P map boards. <br>
			Map boards that are in "Flat Side Up" orientation will be referred to as Type F map boards. <br>
			The "orientation" value in the "board" object will be set to either "P" or "F" to indicate the orientation of the map board's hex grid. <br>
			For backward compatibility a missing "orientation" value will default to "P".

	===Tray Values===		===Tray Values===

Rich: /* Game Board Image File */ added note

2018-12-21T15:55:55Z

Game Board Image File: added note

← Older revision		Revision as of 15:55, 21 December 2018
Line 33:		Line 33:
	* Measure the distance in pixels from the top edge of the image to the start of the first [top most] hex on the map. This is the "yStart" value.		* Measure the distance in pixels from the top edge of the image to the start of the first [top most] hex on the map. This is the "yStart" value.
	* Measure the distance in pixels from start of the top most hex on the map to the start of the second top most hex on the map. These two hexes will '''not''' be in the same column on a "Flat Side Up" orientation map. On a properly scaled image file this will always be 87 pixels for "Point Up" orientation and 50 pixels for "Flat Side Up" orientation. This is the "yStep" value.		* Measure the distance in pixels from start of the top most hex on the map to the start of the second top most hex on the map. These two hexes will '''not''' be in the same column on a "Flat Side Up" orientation map. On a properly scaled image file this will always be 87 pixels for "Point Up" orientation and 50 pixels for "Flat Side Up" orientation. This is the "yStep" value.
			* [[Type_%22F%22_Board_Map_Glitch\|<span style="color: Green">This note</span>]] describes a potential problem with some Type F map boards.

	===Stock Market Image File===		===Stock Market Image File===

Rich: /* Array Element Objects in "btok" Trays */ unlimited

2016-10-31T23:45:20Z

Array Element Objects in "btok" Trays: unlimited

← Older revision		Revision as of 23:45, 31 October 2016
Line 83:		Line 83:

	===Array Element Objects in "btok" Trays===		===Array Element Objects in "btok" Trays===
	* "dups": the number of available tokens of this type.		* "dups": the number of available tokens of this type. <br>Versions 2.4.1 and higher will allow an umlimited number of tokens of this type if the "dups"field contains 0 (zero).
	* "flip": true if this is a 2 sided token.		* "flip": true if this is a 2 sided token.

Rich: /* Array Element Objects in "tile" Trays */ unlimited

2016-10-31T23:44:08Z

Array Element Objects in "tile" Trays: unlimited

← Older revision		Revision as of 23:44, 31 October 2016
Line 79:		Line 79:

	===Array Element Objects in "tile" Trays===		===Array Element Objects in "tile" Trays===
	* "dups": the number of available tiles of this type. The [http://www.diogenes.sacramento.ca.us/18xx_net/ Blackwater Station] Tile Manifests have these counts.		* "dups": the number of available tiles of this type. The [http://www.diogenes.sacramento.ca.us/18xx_net/ Blackwater Station] Tile Manifests have these counts.<br>Versions 2.4.1 and higher will allow an umlimited number of tiles of this type if the "dups"field contains 0 (zero).
	* "rots": the number of rotation images for this tile. Just count the tile images in the column.		* "rots": the number of rotation images for this tile. Just count the tile images in the column.

Rich: /* Link Objects */

2016-09-18T15:18:44Z

Link Objects

← Older revision		Revision as of 15:18, 18 September 2016
Line 95:		Line 95:
	* "link_url": URL for this link in the '''useful links''' menu item.		* "link_url": URL for this link in the '''useful links''' menu item.

	The BOARD18 project maintains a public folder on Google Drive that contains rules and related files for 18XX games. <br>This folder is at [https://drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk].<br>If you wish to add a file to this folder then Email the file to rich at board18.org.		The BOARD18 project maintains a public folder on Google Drive that contains rules and related files for 18XX games. <br>This folder is at [https://drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk?usp=sharing drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk].<br>If you wish to add a file to this folder then Email the file to rich at board18.org.

Rich: /* Link Objects */ added text about Google folder

2016-09-18T15:16:19Z

Link Objects: added text about Google folder

← Older revision		Revision as of 15:16, 18 September 2016
Line 94:		Line 94:
	* "link_name": Name that will appear in the '''useful links''' menu item.		* "link_name": Name that will appear in the '''useful links''' menu item.
	* "link_url": URL for this link in the '''useful links''' menu item.		* "link_url": URL for this link in the '''useful links''' menu item.

			The BOARD18 project maintains a public folder on Google Drive that contains rules and related files for 18XX games. <br>This folder is at [https://drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk drive.google.com/drive/folders/0B-wwptMMyHTAZHpJODJ4OGc5SVk].<br>If you wish to add a file to this folder then Email the file to rich at board18.org.

Rich: /* Other Tray Objects */ added Link Objects

2016-08-26T20:32:14Z

Other Tray Objects: added Link Objects

← Older revision		Revision as of 20:32, 26 August 2016
Line 88:		Line 88:
	===Array Element Objects in "mtok" Trays===		===Array Element Objects in "mtok" Trays===
	* "flip": true if this is a 2 sided token.		* "flip": true if this is a 2 sided token.

			==Link Objects==
			Each object pair in the "link" array contains a link to a web page and that link's name. <br>
			These array element objects each contain two simple objects that are defined here.
			* "link_name": Name that will appear in the '''useful links''' menu item.
			* "link_url": URL for this link in the '''useful links''' menu item.