Minigame Scripting - Revision history

Eonwind: /* Game Rules */

2013-09-23T09:56:47Z

Game Rules

← Older revision		Revision as of 09:56, 23 September 2013
Line 94:		Line 94:
	* ''Anywhere'' (default - can move to any square, vacant or occupied).		* ''Anywhere'' (default - can move to any square, vacant or occupied).

	'''MoveDistance''' can be: an integer number, it's optional and enforce the maximum distance a piece can be moved.		'''MoveDistance''' can be: an integer number, it's optional and enforce the maximum distance a piece can be moved, default is any distance.

	'''MoveDirection''' can be:		'''MoveDirection''' can be:
Line 101:		Line 101:
	* ''Cross''		* ''Cross''
	* ''Diagonal''		* ''Diagonal''
	it's optional and enforce the direction a piece can be moved. Combined with MoveDistance a rule can be defined to enforce distance and direction of a movable piece.		it's optional and enforce the direction a piece can be moved, default is any direction. Combined with MoveDistance a rule can be defined to enforce distance and direction of a movable piece.

Eonwind: /* Game Rules */

2013-09-23T09:28:10Z

Game Rules

← Older revision		Revision as of 09:28, 23 September 2013
Line 93:		Line 93:
	* ''Vacancy'' (player can move pieces to vacant squares only),		* ''Vacancy'' (player can move pieces to vacant squares only),
	* ''Anywhere'' (default - can move to any square, vacant or occupied).		* ''Anywhere'' (default - can move to any square, vacant or occupied).

			'''MoveDistance''' can be: an integer number, it's optional and enforce the maximum distance a piece can be moved.

			'''MoveDirection''' can be:
			* ''Vertical''
			* ''Horizontal''
			* ''Cross''
			* ''Diagonal''
			it's optional and enforce the direction a piece can be moved. Combined with MoveDistance a rule can be defined to enforce distance and direction of a movable piece.


	Example:		Example:
Line 101:		Line 111:
	Another example:		Another example:
	<GameRules>		<GameRules>
	<Rules ~~PlayerTurns="StrictOrdered"~~ MoveType="PlaceOnly" MoveTo="Anywhere" />		<Rules MoveType="PlaceOnly" MoveTo="Anywhere" MoveDistance="2" MoveDirection="Cross" />
	</GameRules>		</GameRules>

Eonwind at 10:55, 18 September 2013

2013-09-18T10:55:52Z

← Older revision		Revision as of 10:55, 18 September 2013
Line 210:		Line 210:
	\|-		\|-
	\|E		\|E
	\|empty tile		\|empty tile (no tile)
	\|-		\|-
	\|F		\|F
	\|tile has piece as per first tile in pattern		\|tile has piece as per first tile in pattern
			\|-
			\|S
			\|specific tile: allows to specify the exact piece in the rule, the allowed pieces are defined in [[Minigame_Scripting#Gameboards_Database_Table\|Gameboards Database Table]]
	\|}		\|}

Eonwind: /* End Game Rules */

2013-09-18T10:51:40Z

End Game Rules

← Older revision		Revision as of 10:51, 18 September 2013
Line 110:		Line 110:
	<MGEndGame>		<MGEndGame>
	<EndGame Coords="relative"/"absolute" [SourceTile="T"] [Winner="T"]>		<EndGame Coords="relative"/"absolute" [SourceTile="T"] [Winner="T"]>
	<Coord Col="?" Row="?" Tile="T" />		<Coord Col="?" Row="?" Tile="T" [Piece="?"]/>
	</EndGame>		</EndGame>
	</MGEndGame>		</MGEndGame>
Line 116:		Line 116:
	{\|		{\|
	!Param		!Param
	!~~Option~~		!Value
			!Optional
	!Description		!Description
			\|-
			\|Coords
			\|relative or absolute
			\|no
			\|tells the server if the coordinates of a tile in the game board are absolute or not
	\|-		\|-
	\|SourceTile		\|SourceTile
	\|[[Minigame_Scripting#Tile_Types\|Tile Types]]		\|[[Minigame_Scripting#Tile_Types\|Tile Types]]
			\|yes
	\|(optional)		\|(optional)
	\|-		\|-
	\|Winner		\|Winner
	\|[[Minigame_Scripting#Tile_Types\|Tile Types]]		\|[[Minigame_Scripting#Tile_Types\|Tile Types]]
	\|~~(optional)~~ winner is white or black player		\|yes
	\|-		\|winner is white or black player
	~~\|Coords~~
	~~\|relative,absolute~~
	~~\|the coordinates of a tile in the game board~~
	\|-		\|-
	\|Col		\|Col
	\|integer		\|integer
			\|no
	\|column number		\|column number
	\|-		\|-
	\|Row		\|Row
	\|integer		\|integer
			\|no
	\|row number		\|row number
	\|-		\|-
	\|Tile		\|Tile
	\|[[Minigame_Scripting#Tile_Types\|Tile Types]]		\|[[Minigame_Scripting#Tile_Types\|Tile Types]]
			\|no
	\|the type of tile		\|the type of tile
			\|-
			\|Piece
			\|[1,..., 9, A, ..., E]
			\|yes
			\|if the [[Minigame_Scripting#Tile_Types\|Tile Types]] is "S" you can choose which piece must be in the Coords position
	\|-		\|-
	\|}		\|}

Eonwind: /* Gameboards Database Table */

2013-09-15T21:29:10Z

Gameboards Database Table

← Older revision		Revision as of 21:29, 15 September 2013
Line 26:		Line 26:
	\|type of pieces in a string format (allowed pieces: 1234567890ABCDE)		\|type of pieces in a string format (allowed pieces: 1234567890ABCDE)
	\|number of players, 2 default, 1 for single player games		\|number of players, 2 default, 1 for single player games
	\|game options (default: White,Checked)		\|game options (default: White,Checked) White/Black (colors the board white or black), Plain (makes it one color), Checked (checkerboard)
	\|specify the game rules in XML format		\|specify the game rules in XML format
	\|specify the end-game rules (winning conditions) in XML format		\|specify the end-game rules (winning conditions) in XML format

Eonwind: /* Action Locations Entry */

2013-09-15T04:57:43Z

Action Locations Entry

← Older revision		Revision as of 04:57, 15 September 2013
Line 48:		Line 48:

	<Examine>		<Examine>
	<GameBoard Name='Weather game' EndGame='Yes' Script='rain' Layout="" Session="personal~~/public~~"/>		<GameBoard Name='Weather game' EndGame='Yes' Script='rain' Layout="10000000A" Session="personal"/>
	<Description>Magic puzzle that makes it rain~~. Make a simple r shape with the game pieces~~.</Description>		<Description>Magic puzzle that makes it rain.</Description>
	</Examine>		</Examine>

Line 73:		Line 73:

	Every session can have 0, 1, 2 or more players attached to it. The first player gets white game pieces and the second player black game pieces. All other players can just watch the game.		Every session can have 0, 1, 2 or more players attached to it. The first player gets white game pieces and the second player black game pieces. All other players can just watch the game.


	==Game Rules==		==Game Rules==

Eonwind: /* Introduction */

2013-09-15T04:54:44Z

Introduction

← Older revision		Revision as of 04:54, 15 September 2013
Line 2:		Line 2:

	==Introduction==		==Introduction==
	Game sessions are bound to a game board (action location) and identified		Game sessions are bound to a game board ([[Action_Locations\|action location]]) and identified
	by a unique name. The name of the game board is defined in the action_locations table (name field).		by a unique name. The name of the game board is defined in the ''action_locations'' table (name field).
	The game itself is defined in the gameboards db table.		The game itself is defined in the ''gameboards'' db table.

	==Gameboards Database Table==		==Gameboards Database Table==

Eonwind: /* Game Rules */

2013-09-15T04:51:54Z

Game Rules

← Older revision		Revision as of 04:51, 15 September 2013
Line 77:		Line 77:
	==Game Rules==		==Game Rules==

	'''PlayerTurns''': can be ''Ordered'' (order of players' moves enforced) or ''StrictOrdered'' (as Ordered, and all players must be present) or ''Relaxed'' (default - free for all).		'''PlayerTurns''' can be:
			* ''Ordered'' (order of players' moves enforced),
			* ''StrictOrdered'' (as Ordered, and all players must be present),
			* ''Relaxed'' (default - free for all).

	'''MoveType''': can be ''MoveOnly'' (player can only move existing pieces), ''PlaceOnly'' (player can only place new pieces on the board; cant move others), or ''PlaceOrMovePiece'' (default - either move existing or place new pieces).		'''MoveType''' can be:
			* ''MoveOnly'' (player can only move existing pieces),
			* ''PlaceOnly'' (player can only place new pieces on the board; cant move others),
			* ''PlaceOrMovePiece'' (default - either move existing or place new pieces).

	'''MoveablePieces''': can be ''Own'' (player can only move their own pieces) or ''Any'' (default - player can move any piece in play).		'''MoveablePieces''' can be:
			* ''Own'' (player can only move their own pieces),
			* ''Any'' (default - player can move any piece in play).

	MoveTo: can be ''Vacancy'' (player can move pieces to vacant squares only) or ''Anywhere'' (default - can move to any square, vacant or occupied).		'''MoveTo''' can be:
			* ''Vacancy'' (player can move pieces to vacant squares only),
			* ''Anywhere'' (default - can move to any square, vacant or occupied).

			Example:
	<GameRules>		<GameRules>
	<Rules PlayerTurns="StrictOrdered" MoveType="MoveOnly" MoveablePieces="Own" MoveTo="Vacancy" />		<Rules PlayerTurns="StrictOrdered" MoveType="MoveOnly" MoveablePieces="Own" MoveTo="Vacancy" />
	</GameRules>		</GameRules>

			Another example:
	<GameRules>		<GameRules>
	<Rules PlayerTurns="StrictOrdered" MoveType="PlaceOnly" MoveTo="Anywhere" />		<Rules PlayerTurns="StrictOrdered" MoveType="PlaceOnly" MoveTo="Anywhere" />

Eonwind: /* Game Rules */

2013-09-15T04:48:19Z

Game Rules

← Older revision		Revision as of 04:48, 15 September 2013
Line 77:		Line 77:
	==Game Rules==		==Game Rules==

	'''PlayerTurns''': can be ''Ordered'' (order of players' moves enforced) or ''StrictOrdered'' (as Ordered, and all players must be present) or 'Relaxed' (default - free for all).		'''PlayerTurns''': can be ''Ordered'' (order of players' moves enforced) or ''StrictOrdered'' (as Ordered, and all players must be present) or ''Relaxed'' (default - free for all).

	'''MoveType''': can be ''MoveOnly'' (player can only move existing pieces), ''PlaceOnly'' (player can only place new pieces on the board; cant move others), or 'PlaceOrMovePiece' (default - either move existing or place new pieces).		'''MoveType''': can be ''MoveOnly'' (player can only move existing pieces), ''PlaceOnly'' (player can only place new pieces on the board; cant move others), or ''PlaceOrMovePiece'' (default - either move existing or place new pieces).

	'''MoveablePieces''': can be ''Own'' (player can only move their own pieces) or ''Any'' (default - player can move any piece in play).		'''MoveablePieces''': can be ''Own'' (player can only move their own pieces) or ''Any'' (default - player can move any piece in play).
Line 90:		Line 90:

	<GameRules>		<GameRules>
	<Rules PlayerTurns="StrictOrdered" MoveType="PlaceOnly" MoveTo="~~Vacancy~~" />		<Rules PlayerTurns="StrictOrdered" MoveType="PlaceOnly" MoveTo="Anywhere" />
	</GameRules>		</GameRules>


	==End Game Rules==		==End Game Rules==

Eonwind at 04:46, 15 September 2013

2013-09-15T04:46:24Z

← Older revision		Revision as of 04:46, 15 September 2013
Line 62:		Line 62:
	The '''Session''' attribute allows a game to be personal (restricted to one-player games) whereby only the player sees the game, no other players or watchers. One such minigame at one action_location can spawn a session per player who plays their own private game. Set to public is for the traditional board game, and is the default if this option is omitted.		The '''Session''' attribute allows a game to be personal (restricted to one-player games) whereby only the player sees the game, no other players or watchers. One such minigame at one action_location can spawn a session per player who plays their own private game. Set to public is for the traditional board game, and is the default if this option is omitted.

	The '''EndGame''' attribute specifies whether this game session is to adhere to the end-game rules. Optional. Default is No.		The '''EndGame''' attribute specifies whether this game session is to adhere to the [[Minigame_Scripting#End_Game_Rules\|end game rules]], it's Optional and Default is No.

			The '''Script''' option allows name a [[ProgressionEvents\|Progression Event]] script to run when the gameboard meets the [[Minigame_Scripting#End_Game_Rules\|end game rules]]. The following variables are defined by the code:
			* Winner
			* Loser
			* Target
			* Actor

	In the future we will add more attributes like for game options and name of a plugin or script for managed games.		In the future we will add more attributes like for game options and name of a plugin or script for managed games.