https://github.com/mr-ema/shnake

Classic snake game for your terminal
https://github.com/mr-ema/shnake

posix-shell shell-game snake-game terminal-game

Last synced: 16 days ago
JSON representation

Classic snake game for your terminal

• Host: GitHub
• URL: https://github.com/mr-ema/shnake
• Owner: mr-ema
• License: other
• Created: 2023-07-25T15:54:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-12T02:29:45.000Z (about 1 year ago)
• Last Synced: 2023-11-13T01:32:15.529Z (about 1 year ago)
• Topics: posix-shell, shell-game, snake-game, terminal-game
• Language: Shell
• Homepage:
• Size: 284 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SHNAKE

Simple for-fun project of the classic snake game implemented in POSIX shell script.

## Resources

- [Shell Check](https://www.shellcheck.net/)

- [POSIX Standards](https://pubs.opengroup.org/onlinepubs/9699919799/)

## Why POSIX Shell?

Why not, my friend! Sometimes, you just gotta shell-ebrate simplicity.

## Features

- [x] Random fruit generation

- [x] Snake grow longer when eat the fruit

- [x] Full Collition detection

- [x] Simple interface with score counting

- [x] Configurable target FPS

## Demo

![Demo](https://github.com/mr-ema/shnake/blob/main/docs/demo.gif)

## Tested Shells 

- [x] Zsh

- [x] Bash

- [x] Dash

- [x] Termux

## Compatibility and Dependencies

This shell script is designed to be POSIX

compatible, following the standards set by the [POSIX

specification](https://pubs.opengroup.org/onlinepubs/9699919799/). This

means that it should run on any POSIX-compliant shell, which includes

most Unix-like systems.

### Dependencies

However, while the script adheres to POSIX standards, there are a few

commands used that are not guaranteed to be available on all operating

systems and you may need to install:

- **bc:** The script uses `bc` (basic calculator) for performing precise

floating-point arithmetic calculations. While `bc` is POSIX-defined

and commonly available, it might not be installed on some minimal or

specialized environments.

- **tput:** The script uses `tput` to control terminal colors and cursor

movement, enhancing the visual aspect of the game. Like `bc`, `tput`

is POSIX-defined but might be missing on certain systems, especially

headless or minimal installations.

## How To Play

1. Clone the repository.

2. Open your terminal and navigate to the directory where the script is located.

3. Make sure you have execute permissions for the script: `chmod +x main.sh`.

4. Run the game: `./main.sh`.

## License

This game is released under the Zero-Clause BSD license. Feel free

to use, modify, and distribute this software for any purpose with or

without fee. The software comes "as is," and the author disclaims all

warranties regarding its use. The author shall not be liable for any

damages resulting from the use or performance of this software.