https://github.com/hannesrudolph/snake-game-test
Just a test repo
https://github.com/hannesrudolph/snake-game-test
Last synced: 3 months ago
JSON representation
Just a test repo
- Host: GitHub
- URL: https://github.com/hannesrudolph/snake-game-test
- Owner: hannesrudolph
- Created: 2025-03-02T18:54:52.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-02T19:27:25.000Z (3 months ago)
- Last Synced: 2025-03-02T19:35:09.375Z (3 months ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript Snake Game
A classic Snake game implemented in TypeScript that runs in the terminal. Control a snake, eat food, grow longer, and try to achieve the highest score without hitting the walls or yourself!
## Features
- Snake movement in four directions (up, down, left, right)
- Food generation at random positions
- Score tracking
- Game over detection (when snake hits the wall or itself)
- Increasing difficulty as the score increases
- Colorful terminal output using chalk
## Prerequisites
Before you begin, ensure you have the following installed:
- [Node.js](https://nodejs.org/) (v12 or higher)
- [npm](https://www.npmjs.com/) (v6 or higher)
You can check your current versions with:
```bash
node --version
npm --version
```
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/snake-game-test.git
cd snake-game-test
```
2. Install dependencies:
```bash
npm install
```
## Running the Game
### Development Mode
Run the game directly with ts-node (faster for development):
```bash
npm run dev
```
### Production Mode
Build the TypeScript code and then run the compiled JavaScript:
```bash
npm run build
npm start
```
## How to Play
- Use the arrow keys to control the snake:
- ↑ (Up Arrow): Move up
- ↓ (Down Arrow): Move down
- ← (Left Arrow): Move left
- → (Right Arrow): Move right
- Eat food (displayed as red dots) to grow the snake and increase your score
- Avoid hitting the walls or the snake's own body
- The game speed increases as your score goes up, making it progressively more challenging
- Press `Ctrl+C` to exit the game at any time
## Game Controls
| Key | Action |
|-----------|----------------------|
| ↑ | Move Up |
| ↓ | Move Down |
| ← | Move Left |
| → | Move Right |
| Ctrl+C | Exit Game |
## Project Structure
```
snake-game-test/
├── src/ # TypeScript source files
│ ├── index.ts # Entry point
│ ├── game.ts # Game logic
│ ├── snake.ts # Snake class
│ ├── food.ts # Food class
│ ├── renderer.ts # Terminal rendering
│ ├── input.ts # Keyboard input handling
│ └── types.ts # Type definitions
├── dist/ # Compiled JavaScript files
├── package.json # Project configuration
├── tsconfig.json # TypeScript configuration
└── README.md # This file
```
## Technical Implementation
The game is built using several key components:
- **Game Class**: Manages the game state, initializes the board, handles the game loop, tracks score, and detects collisions
- **Snake Class**: Represents the snake entity, tracks position and segments, handles movement, and grows when food is eaten
- **Food Class**: Represents food items and generates random positions
- **Renderer**: Clears the terminal, renders the game board, and displays the snake, food, and score
- **Input Handler**: Captures keyboard input and maps keys to directions
## Troubleshooting
### Game doesn't start
- Ensure all dependencies are installed with `npm install`
- Check that you have the correct Node.js version (v12+)
- Try running in development mode with `npm run dev`
### Terminal display issues
- Make sure your terminal supports ANSI colors
- Try resizing your terminal window to ensure the game board fits
- If you see strange characters, check that your terminal supports UTF-8
### Input not working
- Ensure your terminal window is in focus
- Check that your keyboard layout supports arrow keys
- Try running the game in a different terminal emulator
## Future Enhancements
- Game settings (speed, board size)
- High score tracking
- Multiple food types
- Obstacles
- Game pause functionality
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the ISC License - see the LICENSE file for details.
## Acknowledgments
- Inspired by the classic Snake game
- Built with TypeScript and Node.js
- Terminal rendering powered by ANSI escape codes and chalk
This is a random change.
This is a nonsense change for the test PR. The snake now has superpowers and can fly through walls while eating rainbow-colored food that plays music. Quantum physics applies to the snake's movement patterns.