https://github.com/kriskw1999/ratatui-snake

https://github.com/kriskw1999/ratatui-snake

ratatui rust

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kriskw1999/ratatui-snake
• Owner: kriskw1999
• License: gpl-3.0
• Created: 2024-06-11T12:33:52.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-17T08:51:10.000Z (6 months ago)
• Last Synced: 2024-08-02T17:35:05.918Z (5 months ago)
• Topics: ratatui, rust
• Language: Rust
• Homepage:
• Size: 350 KB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ratatui - Snake - Simple terminal based snake game. (💻 Apps / 🕹️ Games and Entertainment)

README

        
# Ratatui Snake

## Preview

https://github.com/kriskw1999/ratatui-snake/assets/71312948/027db3fa-c295-47ad-969d-39018b2cbeca

## Description

This is a simple snake game made designed using Ratatui as TUI library and Rust as programming language.

## How to play

Download the binary from [here](https://github.com/kriskw1999/ratatui-snake/releases)

Or you can install [from the AUR](https://aur.archlinux.org/packages/ratatui-snake): `paru -S ratatui-snake`

## How to run locally

```bash

cargo run

```

## Structure

The project is divided in 3 main modules:

- `game`: Contains the game logic

- `main`: Contains the TUI rendering logic and the main loop

- `collision_detection`: is an external lib that contains the collision detection logic

## Contributing

Feel free to open an issue or a PR if you want to contribute to this project.

Any help is strongly appreciated.