spawnpack 0.1.13 → 0.1.15

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.
Files changed (6) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +128 -128
  3. package/dist/spawnpack.js +505 -388
  4. package/package.json +1 -1
  5. package/templates/AGENTS.md +54 -666
  6. package/templates/CLAUDE.md +54 -666
package/LICENSE CHANGED
@@ -1,21 +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.
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 CHANGED
@@ -1,98 +1,98 @@
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
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
19
  - Optional Rockide recommendation during setup
20
20
  - Optional AI setup:
21
21
  - `CLAUDE.md` for Claude
22
22
  - `AGENTS.md` for Other
23
23
  - `.mcp.json` with keyless MCP servers
24
-
25
- ## Runtime Requirement
26
-
27
- Spawnpack is published on npm, but it runs on **Bun**.
28
-
29
- Install Bun first:
30
- - https://bun.sh/
31
-
32
- ## Install
33
-
34
- ### Global install with Bun
35
-
36
- ```bash
37
- bun add -g spawnpack
38
- ```
39
-
40
- ### Global install with npm
41
-
42
- ```bash
43
- npm i -g spawnpack
44
- ```
45
-
46
- ### One-off run with Bun
47
-
48
- ```bash
49
- bunx spawnpack
50
- ```
51
-
52
- ### Run locally
53
-
54
- ```bash
55
- bun install
56
- bun run src/index.ts
57
- ```
58
-
59
- ## Usage
60
-
61
- ```bash
62
- spawnpack
63
- ```
64
-
65
- Show the installed version:
66
-
67
- ```bash
68
- spawnpack -v
69
- spawnpack --version
70
- ```
71
-
72
- The wizard walks through:
73
-
74
- 1. Project name and author
75
- 2. Marketplace add-on structure toggle
76
- 3. Destination folder
77
- 4. Script API setup
78
- 5. Publisher ID and Project ID when needed
79
- 6. Script packages
80
- 7. `rgl` toggle
81
- 8. Rockide toggle
24
+
25
+ ## Runtime Requirement
26
+
27
+ Spawnpack is published on npm, but it runs on **Bun**.
28
+
29
+ Install Bun first:
30
+ - https://bun.sh/
31
+
32
+ ## Install
33
+
34
+ ### Global install with Bun
35
+
36
+ ```bash
37
+ bun add -g spawnpack
38
+ ```
39
+
40
+ ### Global install with npm
41
+
42
+ ```bash
43
+ npm i -g spawnpack
44
+ ```
45
+
46
+ ### One-off run with Bun
47
+
48
+ ```bash
49
+ bunx spawnpack
50
+ ```
51
+
52
+ ### Run locally
53
+
54
+ ```bash
55
+ bun install
56
+ bun run src/index.ts
57
+ ```
58
+
59
+ ## Usage
60
+
61
+ ```bash
62
+ spawnpack
63
+ ```
64
+
65
+ Show the installed version:
66
+
67
+ ```bash
68
+ spawnpack -v
69
+ spawnpack --version
70
+ ```
71
+
72
+ The wizard walks through:
73
+
74
+ 1. Project name and author
75
+ 2. Marketplace add-on structure toggle
76
+ 3. Destination folder
77
+ 4. Script API setup
78
+ 5. Publisher ID and Project ID when needed
79
+ 6. Script packages
80
+ 7. `rgl` toggle
81
+ 8. Rockide toggle
82
82
  9. AI setup choice (`None`, `Claude`, or `Other`)
83
- 10. Review screen and generation
84
-
85
- ## Generated project options
86
-
87
- Depending on your choices, Spawnpack can generate:
88
-
89
- - `packs/BP`
90
- - `packs/RP`
91
- - `data/scripts/main.ts`
92
- - `packs/BP/scripts/<publisher-id>/<project-id>/main.js`
93
- - `package.json`
94
- - `tsconfig.json`
95
- - `dprint.json`
83
+ 10. Review screen and generation
84
+
85
+ ## Generated project options
86
+
87
+ Depending on your choices, Spawnpack can generate:
88
+
89
+ - `packs/BP`
90
+ - `packs/RP`
91
+ - `data/scripts/main.ts`
92
+ - `packs/BP/scripts/<publisher-id>/<project-id>/main.js`
93
+ - `package.json`
94
+ - `tsconfig.json`
95
+ - `dprint.json`
96
96
  - `config.json` for `rgl`
97
97
  - `CLAUDE.md`
98
98
  - `AGENTS.md`
@@ -109,53 +109,53 @@ Generated MCP servers currently include:
109
109
  - `context7` for library documentation context
110
110
 
111
111
  You can add your own Exa API key later if you need higher Exa limits, but it is not required for the generated scaffold.
112
-
113
- ## Marketplace structure mode
114
-
115
- When enabled, Spawnpack creates marketplace-style nested folders under many BP/RP content directories.
116
-
117
- Example:
118
-
119
- ```text
120
- packs/BP/animation_controllers/publisher/sample/
121
- packs/BP/entities/publisher/sample/
122
- packs/RP/animation_controllers/publisher/sample/
123
- packs/RP/textures/items/publisher/sample/
124
- ```
125
-
126
- This helps multiple add-ons coexist more safely in the same world by reducing content path collisions.
127
-
128
- ## Script dependency versions
129
-
130
- Spawnpack fetches the latest stable npm versions for:
131
-
132
- - `@minecraft/server`
133
- - `@minecraft/server-ui`
134
- - `@minecraft/vanilla-data`
135
- - `@minecraft/math`
136
-
112
+
113
+ ## Marketplace structure mode
114
+
115
+ When enabled, Spawnpack creates marketplace-style nested folders under many BP/RP content directories.
116
+
117
+ Example:
118
+
119
+ ```text
120
+ packs/BP/animation_controllers/publisher/sample/
121
+ packs/BP/entities/publisher/sample/
122
+ packs/RP/animation_controllers/publisher/sample/
123
+ packs/RP/textures/items/publisher/sample/
124
+ ```
125
+
126
+ This helps multiple add-ons coexist more safely in the same world by reducing content path collisions.
127
+
128
+ ## Script dependency versions
129
+
130
+ Spawnpack fetches the latest stable npm versions for:
131
+
132
+ - `@minecraft/server`
133
+ - `@minecraft/server-ui`
134
+ - `@minecraft/vanilla-data`
135
+ - `@minecraft/math`
136
+
137
137
  If version lookup fails, it falls back to baked stable defaults.
138
138
 
139
139
  Only runtime Script API modules, currently `@minecraft/server` and `@minecraft/server-ui`, are written to the behavior pack manifest. npm-side libraries such as `@minecraft/vanilla-data` and `@minecraft/math` stay in the generated `package.json` for imports and bundling.
140
140
 
141
141
  ## Development
142
-
143
- ```bash
144
- bun install
145
- bun run typecheck
146
- bun run build
147
- ```
148
-
149
- ## Publish notes
150
-
151
- The npm package is configured to publish only:
152
-
142
+
143
+ ```bash
144
+ bun install
145
+ bun run typecheck
146
+ bun run build
147
+ ```
148
+
149
+ ## Publish notes
150
+
151
+ The npm package is configured to publish only:
152
+
153
153
  - `dist/spawnpack.js`
154
154
  - `bin/spawnpack.js`
155
155
  - `templates/CLAUDE.md`
156
156
  - `templates/AGENTS.md`
157
157
  - `README.md`
158
158
  - `LICENSE`
159
- - `package.json`
160
-
161
- Internal planning files and local AI/project notes are excluded from the published tarball.
159
+ - `package.json`
160
+
161
+ Internal planning files and local AI/project notes are excluded from the published tarball.