gfcore 0.0.1

Go Fish card game engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

//! Core game state machine.
//!
//! This module provides the [`Game`] engine, the [`GamePhase`] enum,
//! the [`GameState`] snapshot type, and the [`GameEvent`] enum that describes
//! the outcome of every player action.
//!
//! For player moves see [`action::PlayerAction`].
//!
//! # Quick example
//!
//! ```
//! use gfcore::prelude::{Game, GamePhase, GameVariant, Player};
//!
//! let players = vec![Player::new("Alice"), Player::new("Bob")];
//! let game = Game::new(GameVariant::Standard, players).unwrap();
//! assert_eq!(*game.phase(), GamePhase::WaitingForAsk);
//! assert_eq!(game.current_player(), 0);
//! assert!(!game.is_over());
//! ```

pub mod action;
pub(crate) mod state;

pub use action::PlayerAction;
pub use state::{Game, GameEvent, GamePhase, GameState};