rsnaker 0.3.0

A good old retro Snake in terminal UI
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

#![forbid(unsafe_code)]
#![deny(clippy::all)]
#![deny(clippy::pedantic)]
#![allow(clippy::missing_panics_doc)]
// Documentation for all Clippy lints: https://github.com/rust-lang/rust-clippy/
//! # Snake Game using Ratatui
//!
//! This module implements a terminal-based snake game using the Ratatui crate for rendering.
//!
//! ## Features
//! - **Terminal UI**: Uses Ratatui for rendering a grid-based game.
//! - **Game Logic**: Manages snake movement, collisions, and scoring.
//! - **Multithreading**: Uses multiple threads for input handling, rendering at 60 FPS, and game logic execution.
//! - **Emoji-based graphics**: Supports rendering the snake using emojis instead of ASCII.
//! - **Configurable parameters**: With `clap` for command-line arguments.
//!
//! ## TODO
//! - [ ] Add a save score (local db) with a pseudo got from cmdline
//! - [ ] Add some performance log with tracing for example
//! - [ ] Fix too much life display outside of screen
//!
//!
//! ## References
//! - Clippy lints: <https://github.com/rust-lang/rust-clippy/>
//! - Ratatui tutorial: <https://ratatui.rs/tutorials/hello-world/>
//! - Example: <https://ratatui.rs/examples/widgets/canvas/>
//!
//! ## Architecture
//! - Uses `RwLock` for synchronization.
//! - Spawns separate threads for input handling, rendering (60Hz), and game logic execution.
//!
//! ## Documentation generation
//! - `cargo doc --document-private-items --no-deps --open`
//!
//! ## Tests
//!  - As usual run them with `cargo test` the project is set up with a lib containing all the code, and a main.rs just calling it
//!  - As this is a widespread pattern providing full compliance with the Rust test ecosystem, allowing doc comment to be automatically tested, for example.

pub mod controls;
pub mod game_logic;
pub mod graphics;

use crate::game_logic::logger::log_configuration::{
    DEFAULT_LOG_CONFIG_PATH, LogLevel, init_logger, update_log_level,
};
use crate::game_logic::playing_thread_manager::Game;
use clap::Parser;
use game_logic::game_options::GameOptions;
use tracing::{debug, info};

/// # Panics
/// If bad characters (invalid size) are provided for snake body or head
pub fn start_snake() {
    // get command line options and parsed them to check for errors (auto using value parser in clap)
    let mut args = GameOptions::parse();
    //println!("{}", args.to_structured_toml());
    //load args from the already saved preset if its user choice
    if let Some(preset) = args.load {
        args = GameOptions::load_from_toml_preset(preset).unwrap_or_else(|_| {
            panic!("Fail to load Snake configuration file for preset {preset}")
        });
    }

    // Initialize logger: configuration (level, file name, time format and all
    // formatting booleans) is read from a dedicated TOML file inside `init_logger`.
    let (_guard, log_config) = init_logger(Some(DEFAULT_LOG_CONFIG_PATH));
    // CLI log level (if explicitly set, i.e., not Off) overrides the file level.
    if args.log_level != LogLevel::Off {
        update_log_level(args.log_level);
    }
    info!("Snake game arguments parsed and configuration is successful!");
    debug!(log_config = ?log_config);
    // If everything is OK, inits terminal for rendering
    let terminal = ratatui::init();

    // init our own Game engine and a display greeting screen
    Game::menu(args, terminal);

    //in all cases, restore
    ratatui::restore();
}