create-cubeforge-game 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# create-cubeforge-game
|
|
2
|
+
|
|
3
|
+
Scaffold a new [Cubeforge](https://cubeforge.dev) game project in seconds.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# npm
|
|
9
|
+
npx create-cubeforge-game my-game
|
|
10
|
+
|
|
11
|
+
# pnpm
|
|
12
|
+
pnpm create cubeforge-game my-game
|
|
13
|
+
|
|
14
|
+
# yarn
|
|
15
|
+
yarn create cubeforge-game my-game
|
|
16
|
+
|
|
17
|
+
# bun
|
|
18
|
+
bunx create-cubeforge-game my-game
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Then:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
cd my-game
|
|
25
|
+
npm install
|
|
26
|
+
npm run dev
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## What you get
|
|
30
|
+
|
|
31
|
+
A ready-to-run Vite + React + TypeScript project with:
|
|
32
|
+
|
|
33
|
+
- `cubeforge` pre-installed
|
|
34
|
+
- A working example game (platformer with physics, input, camera)
|
|
35
|
+
- `vite.config.ts` configured for canvas games
|
|
36
|
+
- `tsconfig.json` with strict mode
|
|
37
|
+
- Dev server on `localhost:5173`
|
|
38
|
+
|
|
39
|
+
## Links
|
|
40
|
+
|
|
41
|
+
- [Documentation](https://cubeforge.dev)
|
|
42
|
+
- [GitHub](https://github.com/1homsi/cubeforge)
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|