chore: add roadmap to readme
This commit is contained in:
parent
6afd15aa35
commit
9aec20edbf
2 changed files with 29 additions and 16 deletions
|
|
@ -20,6 +20,16 @@ develop, test, and submit changes.
|
||||||
or an unsupported platform) install a JDK yourself. You can avoid Java entirely
|
or an unsupported platform) install a JDK yourself. You can avoid Java entirely
|
||||||
with the `dev:no-db` script below.
|
with the `dev:no-db` script below.
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
- `apps/` - Playable games (each deploys independently)
|
||||||
|
- `packages/` - Shared, publishable libraries
|
||||||
|
- `sites/` - Docs (Astro Starlight) and UI demos — placeholders for now
|
||||||
|
```
|
||||||
|
|
||||||
|
Each app owns its own backend config (e.g. mnswpr's Firestore rules live in
|
||||||
|
`apps/mnswpr/`); the shared packages stay backend-agnostic.
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
35
README.md
35
README.md
|
|
@ -1,25 +1,28 @@
|
||||||
# Cozy Games
|
# Cozy Games
|
||||||
|
|
||||||
A monorepo for **Cozy Games** — a growing collection of small browser
|
A growing collection of small browser games and the shared, reusable packages that power them.
|
||||||
games and the shared, reusable packages that power them.
|
|
||||||
|
|
||||||
## Layout
|
# Roadmap
|
||||||
|
|
||||||
```
|
- **Public APIs** — game-agnostic modules (core, move-log, replay, leaderboard, rating) built inside the first game.
|
||||||
cozy-games/
|
- **Second Game** — validate those APIs by adding a second game through the adapter alone.
|
||||||
├── apps/ Playable games (each deploys independently)
|
- **Reusable Packages** — extract proven modules into standalone, versioned packages.
|
||||||
│ └── mnswpr/ Minesweeper — mnswpr.com (@ayo-run/mnswpr engine + Firebase leaderboard)
|
- **Adapters** — freeze the adapter contract for third-party games to build against.
|
||||||
├── packages/ Shared, publishable libraries
|
|
||||||
│ ├── mnswpr/ @ayo-run/mnswpr — the vanilla Minesweeper game engine
|
|
||||||
│ ├── leaderboard/ @cozy-games/leaderboard — backend-agnostic, time-windowed leaderboard
|
|
||||||
│ └── utils/ @cozy-games/utils — shared browser utilities (storage, timer, …)
|
|
||||||
└── sites/ Docs (Astro Starlight) and UI demos — placeholders for now
|
|
||||||
```
|
|
||||||
|
|
||||||
Each app owns its own backend config (e.g. mnswpr's Firestore rules live in
|
## Packages
|
||||||
`apps/mnswpr/`); the shared packages stay backend-agnostic.
|
|
||||||
|
|
||||||
## Contributing & development
|
| Package | State |
|
||||||
|
| -------------------- | -------------------- |
|
||||||
|
| `mnswpr` (game core) | 🚧 Active development |
|
||||||
|
| leaderboard | ✅ Done (unpublished) |
|
||||||
|
| move-log envelope | 🔮 Planned |
|
||||||
|
| replay engine | 🔮 Planned |
|
||||||
|
| rating math | 🔮 Planned |
|
||||||
|
| `sudoku` (game core) | 🔮 Planned |
|
||||||
|
|
||||||
|
> Note: `@ayo-run/mnswpr` on npm predates this project and will be deprecated in favor of `cozy-games/mnswpr`.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
Setup, running games locally, testing, code style, and local infra all live in
|
Setup, running games locally, testing, code style, and local infra all live in
|
||||||
**[CONTRIBUTING.md](CONTRIBUTING.md)**. In short — this is a
|
**[CONTRIBUTING.md](CONTRIBUTING.md)**. In short — this is a
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue