L19TerminalTicTacToe

Purpose: Educational

Testing Cargo.io submissions, versioning, and documentation.

Tests will be written around a game of TicTacToe. See TODO.

Instructions

Environment

Linux, x86_64.

Installing rust

See: Rustup

Installing L19TerminalTicTacToe

bash git clone https://github.com/L19579/L19_Terminal_TicTacToe.git # Download repo cd #insert_repo_directory cargo build --release

Launching

bash ./target/release/l19_terminal_tictactoe

Controls

• Game input bindings are set in main.rs. System will adapt to UTF-8 binding inputs 2 chars in length listed chronologically. ```rust use l19terminaltictactoe as l19;

  //-- snip

  let input_bindings: Hashmap::<&str, usize> = HashMap::from([ ("a1", 0), ("a2", 1), ("a3", 2), ("b1", 3), ("b2", 4), ("b3", 5), ("c1", 6), ("c2", 7), ("c3", 8),

  ]);

  let mut gm = l19::GameMaster::new(&input_bindings);

  //-- snip ```

• Type in input when prompted. This "bot" is just a pseudorandom number generator. It takes effort to lose.

External links and documentation

Package (0.1.2): Crates.io

Published documentation: Docs.rs

TODO - Complete

• [x] Randomizer decides which player starts.
• [x] X is assigned to player 1, O to player 2.
• [x] Turn based, updated board is printed below. Terminal isn't cleared for simplicity.
• [x] Player is presented with cell ID and types it in to select position when prompted.
• [x] X / O are drawn when player/AI make their move.
• [x] Table state is saved with every move.
• [x] System checks for wins after positions are submitted.
• [x] Full code documentation on Docs.rs
• [x] Top level description on Github; Listed as release.
• [x] Top level description on Crates.io; Listed as release.