tFrogger 🐸

Welcome to tFrogger! A terminal-based Frogger game built with React and Ink, bringing the classic arcade experience right to your command line. 🎮

Overview 🌟

tFrogger is an open-source project that recreates the beloved Frogger game in a terminal environment. It's perfect for retro game enthusiasts and developers who want to enjoy a quick game break without leaving their terminal. Hop your way to victory while avoiding obstacles and navigating treacherous waters across multiple challenging levels! 🏆

Features ✨

• Terminal-based Gameplay: Enjoy Frogger directly in your terminal.
• Classic Mechanics: Dodge cars, ride logs, and reach your goal.
• Multiple Levels: Progress through increasingly challenging levels.
• Dynamic Obstacles: Face new challenges like moving lilypads and alligators.
• High Score System: Compete for the top spot on the leaderboard.
• Responsive Controls: Smooth, responsive keyboard controls for an authentic arcade feel.

Quick Start 🚀

You can start playing tFrogger right away using the following command:

npx tfrogger

This command will download and run the game without needing to install it globally. Instant fun at your fingertips! 🎉

How to Play 🕹️

1. Start the Game: Run npx tfrogger in your terminal.
2. Navigate: Use arrow keys (↑ ↓ ← →) to move your frog.
3. Avoid Traffic: Dodge cars on the busy roads.
4. Cross the River: Hop on logs and lilypads to safely cross the water.
5. Watch for Alligators: In higher levels, avoid the dangerous parts of alligators.
6. Reach the Top: Guide your frog to the lilypads at the top of the screen to score points.
7. Progress: Complete each level to move on to the next challenge.
8. Stay Alive: Don't get hit by cars or fall into the water!
9. Game Over: Press 'R' to restart when the game ends.

Levels 🎚️

1. Level 1: Classic Frogger gameplay with cars and logs.
2. Level 2: Introduces faster obstacles and moving lilypads.
3. Level 3: Adds alligators and increases difficulty across all elements.

Each level increases in speed and complexity, providing a progressively challenging experience.

Tips for Success 🏅

• Time your moves carefully when crossing the road.
• Stay on logs and lilypads while crossing the river - water is not frog-friendly!
• Keep an eye on the direction and speed of logs and lilypads.
• In higher levels, avoid the head and tail of alligators.
• Try to reach the top multiple times to increase your score and advance to the next level.
• Aim for high scores to climb the leaderboard!

Debug Mode 🐛

For developers and curious players, tFrogger includes a debug mode that provides additional information about game state, collisions, and object positioning. To enable debug mode, run the game with the --debug flag:

npx tfrogger --debug

Contributing 🤝

We welcome contributions from the community! Whether it's adding new features, fixing bugs, or improving documentation, your help is appreciated. Feel free to fork the repository, make changes, and submit a pull request. Check out our contributing guidelines for more information.

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.

Contact 📧

For questions, feedback, or bug reports, please reach out to us via GitHub Issues.

Hop into the action and enjoy the game! 🐸🎮