spawnpack 0.1.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/LICENSE +21 -0
- package/README.md +130 -0
- package/bin/spawnpack.js +3 -0
- package/dist/spawnpack.js +2724 -0
- package/package.json +55 -0
- package/templates/CLAUDE.md +802 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 veedy-dev
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Spawnpack
|
|
2
|
+
|
|
3
|
+
Spawnpack is a Bun-powered CLI for scaffolding Minecraft Bedrock add-on projects with a guided terminal wizard.
|
|
4
|
+
|
|
5
|
+
It generates BP/RP structure, optional Script API setup, optional rgl integration, marketplace-ready namespaced content folders, and optional AI tooling files.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- Inline wizard built with `@clack/prompts`
|
|
10
|
+
- Behavior Pack and Resource Pack scaffold
|
|
11
|
+
- Scripting options: None, JavaScript, TypeScript
|
|
12
|
+
- Optional packages:
|
|
13
|
+
- `@minecraft/server`
|
|
14
|
+
- `@minecraft/server-ui`
|
|
15
|
+
- `@minecraft/vanilla-data`
|
|
16
|
+
- `@minecraft/math`
|
|
17
|
+
- Optional `rgl` setup for faster Bedrock builds
|
|
18
|
+
- Optional marketplace add-on structure using nested `namespace/projectId` folders in BP/RP content directories
|
|
19
|
+
- Optional Rockide recommendation during setup
|
|
20
|
+
- Optional AI setup:
|
|
21
|
+
- `CLAUDE.md`
|
|
22
|
+
- `.mcp.json`
|
|
23
|
+
|
|
24
|
+
## Runtime Requirement
|
|
25
|
+
|
|
26
|
+
Spawnpack is published on npm, but it runs on **Bun**.
|
|
27
|
+
|
|
28
|
+
Install Bun first:
|
|
29
|
+
- https://bun.sh/
|
|
30
|
+
|
|
31
|
+
## Install
|
|
32
|
+
|
|
33
|
+
### Global install with Bun
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
bun add -g spawnpack
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### One-off run with Bun
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
bunx spawnpack
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Run locally
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
bun install
|
|
49
|
+
bun run src/index.ts
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Usage
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
spawnpack
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
The wizard walks through:
|
|
59
|
+
|
|
60
|
+
1. Project name and author
|
|
61
|
+
2. Namespace, addon identifier, and project ID
|
|
62
|
+
3. Destination folder
|
|
63
|
+
4. Marketplace add-on structure toggle
|
|
64
|
+
5. Scripting mode
|
|
65
|
+
6. Script packages
|
|
66
|
+
7. `rgl` toggle
|
|
67
|
+
8. Rockide toggle
|
|
68
|
+
9. AI setup toggle
|
|
69
|
+
10. Review screen and generation
|
|
70
|
+
|
|
71
|
+
## Generated project options
|
|
72
|
+
|
|
73
|
+
Depending on your choices, Spawnpack can generate:
|
|
74
|
+
|
|
75
|
+
- `packs/BP`
|
|
76
|
+
- `packs/RP`
|
|
77
|
+
- `data/scripts/main.ts`
|
|
78
|
+
- `packs/BP/scripts/<namespace>/<projectId>/main.js`
|
|
79
|
+
- `package.json`
|
|
80
|
+
- `tsconfig.json`
|
|
81
|
+
- `dprint.json`
|
|
82
|
+
- `config.json` for `rgl`
|
|
83
|
+
- `CLAUDE.md`
|
|
84
|
+
- `.mcp.json`
|
|
85
|
+
|
|
86
|
+
## Marketplace structure mode
|
|
87
|
+
|
|
88
|
+
When enabled, Spawnpack creates marketplace-style nested folders under many BP/RP content directories.
|
|
89
|
+
|
|
90
|
+
Example:
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
packs/BP/animation_controllers/publisher/sample/
|
|
94
|
+
packs/BP/entities/publisher/sample/
|
|
95
|
+
packs/RP/animation_controllers/publisher/sample/
|
|
96
|
+
packs/RP/textures/items/publisher/sample/
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
This helps multiple add-ons coexist more safely in the same world by reducing content path collisions.
|
|
100
|
+
|
|
101
|
+
## Script dependency versions
|
|
102
|
+
|
|
103
|
+
Spawnpack fetches the latest stable npm versions for:
|
|
104
|
+
|
|
105
|
+
- `@minecraft/server`
|
|
106
|
+
- `@minecraft/server-ui`
|
|
107
|
+
- `@minecraft/vanilla-data`
|
|
108
|
+
- `@minecraft/math`
|
|
109
|
+
|
|
110
|
+
If version lookup fails, it falls back to baked stable defaults.
|
|
111
|
+
|
|
112
|
+
## Development
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
bun install
|
|
116
|
+
bun run typecheck
|
|
117
|
+
bun run build
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Publish notes
|
|
121
|
+
|
|
122
|
+
The npm package is configured to publish only:
|
|
123
|
+
|
|
124
|
+
- `dist/spawnpack.js`
|
|
125
|
+
- `templates/CLAUDE.md`
|
|
126
|
+
- `README.md`
|
|
127
|
+
- `LICENSE`
|
|
128
|
+
- `package.json`
|
|
129
|
+
|
|
130
|
+
Internal planning files, Serena state, and local AI/project notes are excluded from the published tarball.
|
package/bin/spawnpack.js
ADDED