snakebyte 1.1.0

A terminal-based snake game with levels, power-ups, and high score tracking.

🐍 SnakeByte - Terminal Snake Game

A feature-rich, interactive Snake game playable entirely in your terminal! Built with Python and the curses module, this game supports color display, multiple levels, power-ups, score tracking, key remapping, and pause functionality.

---

🎮 Features

• 🟩 Colorful terminal graphics

• 🧠 Multiple difficulty levels: Easy, Medium, Hard

• ⚡ Power-ups with dynamic effects:

  • ▲ Speed Up
  • ▼ Slow Down
  • × Shrink Snake
  • + Bonus Score
  • - Score Penalty

• ⌨️ Customizable controls via key_config.json

• ⏸️ Pause menu with instructions

• 💾 High score tracking per difficulty level

• 📜 Gameplay logs stored in JSON format

• 🔁 Seamless restart from game over

---

🚀 Getting Started

🔧 Prerequisites

• Python 3.7 or higher
• Compatible with Linux, macOS, and Windows (Windows installs windows-curses)

---

📦 Installation

Install via pip:

pip install snakebyte

Or clone manually from GitHub and install dependencies:

GitHub Repository: https://github.com/HattoriMan/SnakeByte

Note: Follow the instructions in the repository README.

---

Usage

• Start the game(default)

snake

or

snake play

• Debug mode

snake play --debug

• View statistics

snake stats

• Reset all data

snake reset

---

🎮 Controls

Action	Default Keys
Move Up	W / ↑
Move Down	S / ↓
Move Left	A / ←
Move Right	D / →
Pause / Resume	P
Instructions	I
Quit	Q / Esc

---

🗂️ Project Structure

snakebyte/
├── snakebyte/              # Main game package
│   ├── __init__.py
│   ├── game.py             # Main game logic and entry point
│   ├── utils.py            # Game utilities
│   ├── config.py           # Game configuration
│   └── key_config.py       # Key handling logic
├── key_config.json         # User-customizable key bindings
├── logs/                   # Game logs and high scores (auto-created on run)
├── pyproject.toml          # Modern Python packaging configuration
├── MANIFEST.in             # Package data inclusion rules
├── README.md               # Project documentation
└── LICENSE                 # MIT License file

---

🧪 Levels & Gameplay

• Levels: Easy, Medium, Hard
• Snake wraps around screen edges
• Avoid biting your own body
• Collect food (◉) to grow and score
• Power-ups spawn periodically

---

📝 Logging and Data Storage

Data is stored in your system's user data directory (via appdirs), depending on your OS:

• Linux: ~/.local/share/snakebyte/
• Windows: %LOCALAPPDATA%\snakebyte\
• macOS: ~/Library/Application Support/snakebyte/

These are the specific logging files stored:

• Game history: logs/app.jsonl
• High scores: logs/score.json
• Error traces / Debug logs: logs/error_traceback.log
• Key bindings: key_config.json

Example:

{
  "left": ["a", "left"],
  "right": ["d", "right"]
}

---

🔜 Upcoming Features

✨ Planned enhancements:

• 🔊 Sound effects
• 💾 Save/Load game state
• 🧩 Challenges & achievements
• 🌐 Online high score leaderboard

---

📄 License

MIT License – free to use, modify, and distribute.

---

🙌 Acknowledgements

Thanks to the Python community and open-source contributors for making this possible. Inspired by the classic Snake game we all loved.

---