Package net.demilich.metastone.game

package net.demilich.metastone.game

The core engine code for Spellsource.

GameContext contains the state, player delegates and state-manipulation code (i.e. the GameLogic). This is the starting point for interacting with the engine. You'll create an instance of a GameContext for nearly anything you want to do.

To create new player behaviours like AIs, explore the Behaviour hierarchy of classes. In particular, GameStateValueBehaviour represents a complex AI.

The CardCatalogue contains references to the cards. They are accessed by their IDs, which correspond to their filenames in the cards/src/main/resources/cards directory, minus the ".json" extension.

Cards are deserialized from CardDesc objects. The type system for the card JSON is not straight forward. Some types, like CardDesc, EnchantmentDesc and OpenerDesc deserialize conventionally, where each field in the class corresponds exactly in name and type to a field in a JSON object. However, all other types are modeled as interable maps that subclass Desc. These have corresponding key enums, like SpellArg, whose camelCased version appears in the JSON. The type of the value can be discovered by looking at the corresponding DescDeserializer subclass's DescDeserializer.init(net.demilich.metastone.game.cards.desc.DescDeserializer.SerializationContext) method and cross-referencing the ParseValueType that appears as a value of an enum, ParseValueType key pair with ParseUtils.parse(com.fasterxml.jackson.databind.JsonNode, net.demilich.metastone.game.cards.desc.ParseValueType, com.fasterxml.jackson.databind.DeserializationContext).

See Also:

• for more about how to start a Spellsource game and how game state is stored and manipulated.
• for more about how the rules of the game are implemented
• for more about how to get player actions
• for more about the card JSON format
• for more about spell effects
• for more about how data is stored in the game

Related Packages

Package	Description
net.demilich.metastone.game.actions	Game actions are things players can do.
net.demilich.metastone.game.behaviour	Behaviours describe how a player should respond to events in the game.
net.demilich.metastone.game.cards	Cards contains important enums, deserialization code, the card catalogue and the card entity.
net.demilich.metastone.game.decks	Decks contains code to define a collection of cards for play.
net.demilich.metastone.game.entities	Entities are the various classes that live inside a match, like a card, hero, minion, and weapon.
net.demilich.metastone.game.environment	The environment holds ephemeral data (variables) during the course of a game.
net.demilich.metastone.game.events	Events correspond to things that happen inside the game that other rules can react to.
net.demilich.metastone.game.logic	This package contains the game logic, the rules of the game of Spellsource.
net.demilich.metastone.game.services	Interfaces for multiplayer cross-context gameplay.
net.demilich.metastone.game.spells	Spells contain all the functional pieces of the card JSON (Click on description to learn more about how to use this).
net.demilich.metastone.game.statistics	This package collects statistics about the game as it plays out.
net.demilich.metastone.game.targeting	Targeting contains the types used to describe various targets of effects.
net.demilich.metastone.game.utils	Various utility classes for doing math and loading resources.

Classes

Class	Description
GameContext	A game context helps execute a match of Spellsource, providing a place to store state, deliver requests for actions to players, apply those player actions through a GameLogic, and then save the updated state as a result of those actions.
Player	The Player class stores almost the state that corresponds to a particular player, like a collection of EntityZone objects and select Attribute and PlayerAttribute attributes as an Entity that exists in the game.