Skip to content

Commit eec2a6a

Browse files
committed
docs: more
1 parent acacdd2 commit eec2a6a

File tree

6 files changed

+91
-10
lines changed

6 files changed

+91
-10
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. Windows 10, macOS Sonoma]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone 13]
33+
- OS: [e.g. iOS 17.0]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
39+
40+
---
41+
*P.S. This is just a template, feel free to ignore it and write whatever you want! We appreciate any feedback.*
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEAT] "
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
*P.S. This is just a template, feel free to ignore it and write whatever you want! We appreciate any feedback.*
10+
11+
---
12+
13+
**Is your feature request related to a problem? Please describe.**
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what you want to happen.
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,33 @@
66

77
> **[➡️ Try the Live Demo!](https://tobenot.top/Basic-Web-Game/)**
88
9+
[Demo Screenshot](./docs/assets/screenshot.webp)
10+
11+
[![Play Beyond Books on Itch.io](./docs/assets/bb_screenshot.webp)](https://tobenot.itch.io/beyond-books)
12+
913
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**.
1014

1115
> **Note**: For detailed technical documentation, please refer to our **[Full Documentation](./docs/README.md)**.
1216
1317
---
1418

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+
1527
## ✨ Features
1628

1729
- **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.
1931
- **Vite Powered**: Fast development server and optimized builds.
2032
- **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**.
2234
- 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.
2536

2637
## 🚀 Getting Started
2738

@@ -78,17 +89,22 @@ A more detailed breakdown of the project structure is available in [our document
7889
7990
## 🎨 Customization
8091
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).
8293
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
8695
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.
8897
8998
## 🤝 Contributing
9099
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.
92108
93109
## 📄 License
94110

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
* **4. [创建与扩展](./04-creation-and-extension.md)**
1313
* **5. [构建与部署](./05-build-and-deploy.md)**
1414
* **6. [贡献指南](./06-contributing.md)**
15+
* **7. [项目路线图](./ROADMAP.md)**
1516

1617
---
1718

docs/assets/bb_screenshot.webp

13.9 KB
Loading

docs/assets/screenshot.webp

53.6 KB
Loading

0 commit comments

Comments
 (0)