Snake Game using Ratatui

It is 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 & toml file.

TODO

• Add a save score (local db) with a pseudo got from cmdline
• Add some performance log with tracing, for example
• Show game options in the menu, and visually change them
• Enhance fruits eaten detection and grid management with multiple emojis as body
• Manage mouse/touchscreen mouvement to control the snake
• Internal code: Provide a macro exemple for trait implementation widget and this error use.

💖 Support

• If you like this game and want to contribute to more amazing features, consider giving me a coffee on kofi 🥤to support development.

Installation

✅ Prerequisites

• 🦀 Have Rust and compilation tools installed
  If you don't have Rust yet:

• On Windows, Install Rust using the official .exe installer https://www.rust-lang.org/tools/install (as it works Out-Of-The-Box on windows)

• On Linux See
  👉 Installation Rust and tools for Linux for instructions

• On Android use a linux emulator and follow same instruction as linux, tested with:

  • Android using Ubuntu,
  • Termux For easier use, END key works as ENTER and HOME as a pause key.

• 💻 Use a terminal that supports emoji

  • On Windows, the default terminal supports emoji out of the box.
  • On Linux / Android, if need install the Noto Emoji font. See
    👉 Emoji font support for instructions.

For this project

• Clone this repository git clone https://github.com/FromTheRags/rsnake.git
• Go to the directory cd rsnake

Run the Game

• To run the game, either:cargo run or cargo run --manifest-path rsnake/Cargo.toml (if in another directory)
• To see run options, use: rsnake --help
• E.g., rsnake -z 🐼 -b 🍥 or cargo run -- -z 🐼 -b 🍥
• To save a set of commands, create and alias or use --save to generate to a snake_config.toml file near the executable.
• Then load with --load option. Shipped one
• To install the game as a command:
  cargo install --path .
  And then run the game with: rsnake

Architecture

• Uses Arc & 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.
• To have a coverage report, install llvm-cov: rustup component add llvm-tools-preview cargo install cargo-llvm-cov
• And run cargo llvm-cov --open
• A great coverage is not a goal for this project (tests are only there to showcase tests in rust),
• For reference the current coverage is :

Installation Rust and tools for Linux

Make sure your system has curl, gcc and git installed:

sudo apt update
sudo apt install curl git gcc -y

Use the official installer rustup, or any alternative method on https://www.rust-lang.org/tools/install (by your own):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• Follow the prompts in the terminal.
• After installation, run:

echo "source '$HOME/.cargo/env'" >> ~/.bashrc
source ~/.bashrc

• Verify the installation:

rustc --version

Enable Emoji Font Support

To properly display emoji characters in your terminal and system fonts, install an emoji-compatible font.

For Ubuntu/Debian-based distros:

sudo apt install fonts-noto-color-emoji

For Arch Linux:

sudo pacman -S noto-fonts-emoji

For Fedora:

sudo dnf install google-noto-emoji-color-fonts

Optional: Configure Font Fallback (if emojis still do not render)

Create or edit the following file:

~/.config/fontconfig/fonts.conf

Add:

<?xml version="1.0"?>
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
<fontconfig>
    <alias>
        <family>sans-serif</family>
        <prefer>
            <family>Noto Color Emoji</family>
        </prefer>
    </alias>
</fontconfig>

Then refresh the font cache:

fc-cache -f -v

Test Your Setup

Run:

echo "Rust is awesome! 🦀🔥🚀"

You should see emojis rendered correctly in your terminal or text editors.

• Then follow quick installation instructions

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/
• Git over-bloated: https://rtyley.github.io/bfg-repo-cleaner/