|
6 | 6 |
|
7 | 7 | > **[➡️ Try the Live Demo!](https://tobenot.top/Basic-Web-Game/)**
|
8 | 8 |
|
| 9 | +[Demo Screenshot](./docs/assets/screenshot.webp) |
| 10 | + |
| 11 | +[](https://tobenot.itch.io/beyond-books) |
| 12 | + |
9 | 13 | A simple, modular, and extensible web game template based on React, TypeScript, and Vite. Designed for rapid prototyping and building games for platforms like **itch.io** and **GitHub Pages**.
|
10 | 14 |
|
11 | 15 | > **Note**: For detailed technical documentation, please refer to our **[Full Documentation](./docs/README.md)**.
|
12 | 16 |
|
13 | 17 | ---
|
14 | 18 |
|
| 19 | +## Why Carrot Web Game Template? |
| 20 | + |
| 21 | +While you can always build a project from scratch with `create-react-app`, this template is specifically optimized for web game development, saving you from common setup headaches: |
| 22 | + |
| 23 | +- **Game-Centric Architecture**: Separates the core engine (`carrot`) from game-specific logic (`games`), promoting organized, reusable code. |
| 24 | +- **One-Command Deployments**: Built-in scripts for **itch.io** and **GitHub Pages** that automatically handle tricky path configurations, letting you focus on your game. |
| 25 | +- **Essential Components Included**: Comes with pre-built, customizable components like `ImageLoader`, `TypewriterText`, and `GameShell` for aspect ratio and screen orientation control. |
| 26 | + |
15 | 27 | ## ✨ Features
|
16 | 28 |
|
17 | 29 | - **Modular Architecture**: Core engine (`carrot`) is separated from game-specific logic (`games`).
|
18 |
| -- **React + TypeScript**: Modern, type-safe UI development with reusable core components like `ImageLoader` and `TypewriterText`. |
| 30 | +- **React + TypeScript**: Modern, type-safe UI development with reusable core components. |
19 | 31 | - **Vite Powered**: Fast development server and optimized builds.
|
20 | 32 | - **Automated Deployments**:
|
21 |
| - - Built-in, one-command script (`npm run build:itch`) to version, build, and package your game for **itch.io**. |
| 33 | + - Built-in script (`npm run build:itch`) to version, build, and package your game for **itch.io**. |
22 | 34 | - Streamlined deployment to **GitHub Pages** via `npm run deploy`.
|
23 |
| -- **Ready for Deployment**: Built-in scripts for easy deployment to **itch.io** and **GitHub Pages**. |
24 |
| -- **Easy to Customize**: Designed to be a clean starting point for your next web-based game. |
| 35 | +- **Easy to Customize**: A clean starting point for your next web game. |
25 | 36 |
|
26 | 37 | ## 🚀 Getting Started
|
27 | 38 |
|
@@ -78,17 +89,22 @@ A more detailed breakdown of the project structure is available in [our document
|
78 | 89 |
|
79 | 90 | ## 🎨 Customization
|
80 | 91 |
|
81 |
| -To create your own game: |
| 92 | +To create your own game, follow the detailed guide in [our documentation](./docs/04-creation-and-extension.md). |
82 | 93 |
|
83 |
| -1. Duplicate the `src/games/carrot-card-demo` directory and rename it. |
84 |
| -2. Develop your game-specific logic, components, and types inside that new directory. |
85 |
| -3. In `src/App.tsx`, change the import to point to your new game's main component. |
| 94 | +## 🗺️ Roadmap |
86 | 95 |
|
87 |
| -The detailed guide is in [our documentation](./docs/04-creation-and-extension.md). |
| 96 | +We have exciting plans for the future! Check out our **[Roadmap](./docs/ROADMAP.md)** to see what's next and how you can contribute. |
88 | 97 |
|
89 | 98 | ## 🤝 Contributing
|
90 | 99 |
|
91 |
| -Contributions are welcome! If you have ideas for improvements or find a bug, please first read our **[Contribution Guide](./docs/06-contributing.md)**. |
| 100 | +Contributions are welcome! If you have ideas for improvements or find a bug, please first read our **[Contribution Guide](./docs/06-contributing.md)** and check out the issues page. |
| 101 | +
|
| 102 | +### 💡 Help Wanted |
| 103 | +
|
| 104 | +We are actively looking for help in the following areas: |
| 105 | +- **More Core Components**: Ideas for reusable UI or logic components (e.g., `SoundManager`, `SpriteAnimation`). |
| 106 | +- **Documentation**: Improving existing docs or adding translations. |
| 107 | +- **Game Samples**: Creating more diverse game examples to showcase the engine's capabilities. |
92 | 108 |
|
93 | 109 | ## 📄 License
|
94 | 110 |
|
|
0 commit comments