xiangqipy Namespace Reference

Python package that wraps the C++ core. More...

Namespaces
namespace	__main__
	Provides the entry point to play a Game.
namespace	app
	Contains a single function, run(), that does everything needed to play a Game.
namespace	app_simple
namespace	command_input
	Contains classes for collecting command line input, and converting to a form that will be convenient for instantiating all of the objects needed to play a Game.
namespace	core_dataclass_mirrors
	Contains classes that mirror the structure of some core C++ classes, primarily to facilitate easy IO of a GameSummary with msgspec.
namespace	enums
	Enums that are only used on the Python side of the app.
namespace	game
	Contains Game class.
namespace	game_interfaces
	Python abstract classes used by a Game.
namespace	game_output_generator
	Contains the GameOutputGenerator class.
namespace	game_summary
	GameSummary class and its component classes.
namespace	game_summary_converter
namespace	game_summary_io
	Contains functions for importing / exporting a GameSummary from / to .json file.
namespace	game_summary_plot_manager
	Contains the GameSummaryPlotManager class.
namespace	game_summary_plotters
	Contains the GameSummaryPlotter abstract base class, and multiple subclasses that implement it.
namespace	handlers
	Handles errors and signals terminal UI is running.
namespace	move_translator
	Contains functions used to convert algebraic board notation into integer indices array notation.
namespace	piece_info_extractor
	No longer used, but keep for reference: PieceReader for converting int to PieceType.
namespace	piece_points
	No longer used, but keep for reference: classes for handling piece points.
namespace	player_builder
	Classes for building Player objects.
namespace	player_summary
	Contains PlayerSummary class.
namespace	players
	Implementations of Player, and Exceptions for notifying specific Player types of illegal proposed Move.
namespace	terminal_output
	Classes for terminal UI output including board representation and, messages requesting info, and status messages.

Detailed Description

Python package that wraps the C++ core.

Runs a game with two Players and a GameBoard.