tpong
v0.2.1
Published
An implementation of the classic Pong game for your Terminal, built with [React](https://github.com/facebook/react/) and [Ink](https://github.com/vadimdemedes/ink).
Downloads
14
Readme
tPong 🏓
An implementation of the classic Pong game for your Terminal, built with React and Ink.
✨ Features
- 🕹️ Single-player vs AI and local two-player modes
- 🌈 Colorful terminal graphics
- 🚀 Dynamic difficulty with increasing ball speed
🎮 How to Play
Single-player Mode
- Use the ⬆️ and ⬇️ arrow keys to control the left paddle
- Compete against an AI-controlled right paddle
Two-player Mode
- Player 1: Use the ⬆️ and ⬇️ arrow keys to control the left paddle
- Player 2: Use the 'W' and 'S' keys to control the right paddle
General Controls
- Press Enter to start the game from the menu
- Press Esc during the game to return to the menu
- Press Esc on the game over screen to exit the game
🚀 Running the Game
To start the game in single-player mode:
npx tpong
To start the game in two-player mode:
npx tpong --multiplayer
For a smooth experience, ensure you are using a terminal that supports color and has a large enough display.
🛠️ Development and Contribution
We welcome contributions! To set up a development environment:
- Fork the repository and clone it to your local machine.
- Install the dependencies with
yarn install
. - Run
yarn start
to test your changes in real-time.
When submitting a pull request:
- Make sure to document any new features or changes.
- Test your code thoroughly.
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
👥 Contributors
Special thanks to everyone who has contributed to this project. Feel free to open issues and contribute to improving the game!
Enjoy the game and happy ponging! 🏓