@bedrock-oss/add-on-registry 1.0.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 +48 -0
- package/package.json +32 -0
- package/registry.js +260 -0
- package/types.d.ts +6 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Bedrock OSS
|
|
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,48 @@
|
|
|
1
|
+
# Add-On Registry
|
|
2
|
+
A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-Add-Ons to display accurate information about packs.
|
|
3
|
+
|
|
4
|
+
If you are an Add-On creator, you are welcome to add your pack to the registry so that it can be displayed accurately in other Add-Ons that display information about content from various Add-Ons.
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
## Contribution
|
|
8
|
+
To add your project(s), create a new JSON file or edit one inside the `/registry` folder with the required details, and submit it via pull-request.
|
|
9
|
+
Your pull-request will automatically merge all JSON files together into 1 `registry.js`.
|
|
10
|
+
|
|
11
|
+
### Steps
|
|
12
|
+
1. Create a new JSON file or edit one inside the `/registry` folder.
|
|
13
|
+
- If you're a "new" creator, the filename should be your creator/studio name (e.g. `ascent.json`, `spark.json`).
|
|
14
|
+
2. Follow the structure used in the other files. Example:
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"ascent_paint": {
|
|
18
|
+
"name": "Paint",
|
|
19
|
+
"creator": "ASCENT"
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
3. Commit your JSON file, then open a pull request.
|
|
24
|
+
|
|
25
|
+
### Notes
|
|
26
|
+
- The **key** should be the ID/namespace of your Add-On (the same namespace you use for blocks, entities, etc.).
|
|
27
|
+
- `name`: Display name of your Add-On.
|
|
28
|
+
- `creator`: Name of the creator or studio.
|
|
29
|
+
- Duplicate keys are not allowed. The build will fail if a namespace is already taken.
|
|
30
|
+
- Please use 4 spaces for indentation in your JSON file for consistency across all creator files.
|
|
31
|
+
|
|
32
|
+
## Including it in your pack
|
|
33
|
+
To use the registry in your project, install it via NPM from this repository:
|
|
34
|
+
```
|
|
35
|
+
npm i https://github.com/Bedrock-OSS/add-on-registry
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
You can now use it in your project like this:
|
|
39
|
+
```javascript
|
|
40
|
+
import { Registry } from "bedrock-add-on-registry"
|
|
41
|
+
|
|
42
|
+
function getAddOnName(identifier) {
|
|
43
|
+
const namespace = identifier.split(":")[0];
|
|
44
|
+
const entry = Registry[namespace];
|
|
45
|
+
// Use the namespace itself as fallback
|
|
46
|
+
return entry ? entry.name : namespace;
|
|
47
|
+
}
|
|
48
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@bedrock-oss/add-on-registry",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "A registry for Minecraft Bedrock Add-Ons and their basic meta-data. This is intended to be used by features such as WAILA-add-ons to display accurate information about packs.",
|
|
5
|
+
"main": "registry.js",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"types": "types.d.ts",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/Bedrock-OSS/add-on-registry.git"
|
|
11
|
+
},
|
|
12
|
+
"keywords": [
|
|
13
|
+
"Minecraft"
|
|
14
|
+
],
|
|
15
|
+
"author": "Bedrock-OSS",
|
|
16
|
+
"license": "MIT",
|
|
17
|
+
"bugs": {
|
|
18
|
+
"url": "https://github.com/Bedrock-OSS/add-on-registry/issues"
|
|
19
|
+
},
|
|
20
|
+
"homepage": "https://github.com/Bedrock-OSS/add-on-registry#readme",
|
|
21
|
+
"scripts": {
|
|
22
|
+
"build": "node scripts/build-registry.js",
|
|
23
|
+
"prepublishOnly": "npm run build"
|
|
24
|
+
},
|
|
25
|
+
"files": [
|
|
26
|
+
"registry.js",
|
|
27
|
+
"types.d.ts"
|
|
28
|
+
],
|
|
29
|
+
"publishConfig": {
|
|
30
|
+
"access": "public"
|
|
31
|
+
}
|
|
32
|
+
}
|
package/registry.js
ADDED
|
@@ -0,0 +1,260 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file is auto-generated by scripts/build-registry.js.
|
|
3
|
+
* Source data lives in /registry/*.json.
|
|
4
|
+
*
|
|
5
|
+
* @type {import("./types").RegistryMap}
|
|
6
|
+
*/
|
|
7
|
+
export const Registry = {
|
|
8
|
+
andexsa: {
|
|
9
|
+
name: "8Crafter's Entity Scale, NBT, and Behavior Modifier, Bossbar, and Morph Addon",
|
|
10
|
+
creator: "8Crafter",
|
|
11
|
+
},
|
|
12
|
+
andexdb: {
|
|
13
|
+
name: "8Crafter's Server Utilities & Debug Sticks",
|
|
14
|
+
creator: "8Crafter",
|
|
15
|
+
},
|
|
16
|
+
andexrp: {
|
|
17
|
+
name: "8Crafter's Entity Scale, NBT, and Behavior Modifier, Bossbar, and Morph Addon",
|
|
18
|
+
creator: "8Crafter",
|
|
19
|
+
},
|
|
20
|
+
andexsl: {
|
|
21
|
+
name: "8Crafter's Secret Items Loader",
|
|
22
|
+
creator: "8Crafter",
|
|
23
|
+
},
|
|
24
|
+
aria_pp: {
|
|
25
|
+
name: "Planes Pro",
|
|
26
|
+
creator: "AriaCreations",
|
|
27
|
+
},
|
|
28
|
+
ascent_paint: {
|
|
29
|
+
name: "Paint",
|
|
30
|
+
creator: "ASCENT",
|
|
31
|
+
},
|
|
32
|
+
bf_rb: {
|
|
33
|
+
name: "Biomes",
|
|
34
|
+
creator: "Block Factory",
|
|
35
|
+
},
|
|
36
|
+
bluemods: {
|
|
37
|
+
name: "BlueMods Anticheat",
|
|
38
|
+
creator: "BlueShadow",
|
|
39
|
+
},
|
|
40
|
+
cc_su: {
|
|
41
|
+
name: "SCP: Uncaged Add-On",
|
|
42
|
+
creator: "Cloud Corp",
|
|
43
|
+
},
|
|
44
|
+
darkosto_elemental_crops: {
|
|
45
|
+
name: "Elemental Crops",
|
|
46
|
+
creator: "Darkosto",
|
|
47
|
+
},
|
|
48
|
+
float_fc: {
|
|
49
|
+
name: "Forest Craft",
|
|
50
|
+
creator: "Float Studios",
|
|
51
|
+
},
|
|
52
|
+
float_fca: {
|
|
53
|
+
name: "Fur Craft",
|
|
54
|
+
creator: "Float Studios",
|
|
55
|
+
},
|
|
56
|
+
float_br: {
|
|
57
|
+
name: "The Backrooms Add-On",
|
|
58
|
+
creator: "Float Studios",
|
|
59
|
+
},
|
|
60
|
+
gm1_ord: {
|
|
61
|
+
name: "Sonic",
|
|
62
|
+
creator: "Gamemode One",
|
|
63
|
+
},
|
|
64
|
+
gm1_zen: {
|
|
65
|
+
name: "How to Train Your Dragon",
|
|
66
|
+
creator: "Gamemode One",
|
|
67
|
+
},
|
|
68
|
+
hf_mzs: {
|
|
69
|
+
name: "Mowzie’s Mobs",
|
|
70
|
+
creator: "Honeyfrost",
|
|
71
|
+
},
|
|
72
|
+
jm: {
|
|
73
|
+
name: "jeanmajid",
|
|
74
|
+
creator: "jeanmajid",
|
|
75
|
+
},
|
|
76
|
+
mco_tde: {
|
|
77
|
+
name: "The Dawn Era",
|
|
78
|
+
creator: "Mush Co",
|
|
79
|
+
},
|
|
80
|
+
nps_mot: {
|
|
81
|
+
name: "More Ores and Tools",
|
|
82
|
+
creator: "Netherpixel",
|
|
83
|
+
},
|
|
84
|
+
oreville_15yr: {
|
|
85
|
+
name: "15 Year Party Supplies",
|
|
86
|
+
creator: "Oreville Studios",
|
|
87
|
+
},
|
|
88
|
+
oreville_vm: {
|
|
89
|
+
name: "Vibrant Memories Add-On",
|
|
90
|
+
creator: "Oreville Studios",
|
|
91
|
+
},
|
|
92
|
+
oreville_rb: {
|
|
93
|
+
name: "Realistic Biomes Add-On",
|
|
94
|
+
creator: "Oreville Studios",
|
|
95
|
+
},
|
|
96
|
+
oreville_tc: {
|
|
97
|
+
name: "Time Capsule Add-On",
|
|
98
|
+
creator: "Oreville Studios",
|
|
99
|
+
},
|
|
100
|
+
oreville_wb: {
|
|
101
|
+
name: "World Builder Add-On",
|
|
102
|
+
creator: "Oreville Studios",
|
|
103
|
+
},
|
|
104
|
+
oreville_hp: {
|
|
105
|
+
name: "Health Bars Add-On",
|
|
106
|
+
creator: "Oreville Studios",
|
|
107
|
+
},
|
|
108
|
+
pu_biomes: {
|
|
109
|
+
name: "MORE BIOMES Add-On",
|
|
110
|
+
creator: "Pixelusion",
|
|
111
|
+
},
|
|
112
|
+
pu_bn: {
|
|
113
|
+
name: "BURNT Add-On",
|
|
114
|
+
creator: "Pixelusion",
|
|
115
|
+
},
|
|
116
|
+
pu_blasters: {
|
|
117
|
+
name: "BLASTERS Add-On",
|
|
118
|
+
creator: "Pixelusion",
|
|
119
|
+
},
|
|
120
|
+
pixelusion_dbp: {
|
|
121
|
+
name: "PORTAL BACKPACKS Add-On",
|
|
122
|
+
creator: "Pixelusion",
|
|
123
|
+
},
|
|
124
|
+
pixelusion_td: {
|
|
125
|
+
name: "Training Dummies Add-On",
|
|
126
|
+
creator: "Pixelusion",
|
|
127
|
+
},
|
|
128
|
+
pu_se: {
|
|
129
|
+
name: "SHIELDS Add-On",
|
|
130
|
+
creator: "Pixelusion",
|
|
131
|
+
},
|
|
132
|
+
pod_farm: {
|
|
133
|
+
name: "FARMING",
|
|
134
|
+
creator: "Podcrash",
|
|
135
|
+
},
|
|
136
|
+
pod_gard: {
|
|
137
|
+
name: "GARDENING",
|
|
138
|
+
creator: "Podcrash",
|
|
139
|
+
},
|
|
140
|
+
pod_engi: {
|
|
141
|
+
name: "MACHINES",
|
|
142
|
+
creator: "Podcrash",
|
|
143
|
+
},
|
|
144
|
+
pod_rpg: {
|
|
145
|
+
name: "RPG SKILLS",
|
|
146
|
+
creator: "Podcrash",
|
|
147
|
+
},
|
|
148
|
+
pod_trn: {
|
|
149
|
+
name: "TRAINS",
|
|
150
|
+
creator: "Podcrash",
|
|
151
|
+
},
|
|
152
|
+
httyd: {
|
|
153
|
+
name: "Age of Berk",
|
|
154
|
+
creator: "S3XT4 Studios",
|
|
155
|
+
},
|
|
156
|
+
shapescape_ext: {
|
|
157
|
+
name: "The Extinct",
|
|
158
|
+
creator: "Shapescape",
|
|
159
|
+
},
|
|
160
|
+
spark_portals: {
|
|
161
|
+
name: "Spark Portals",
|
|
162
|
+
creator: "Spark Universe",
|
|
163
|
+
},
|
|
164
|
+
spark: {
|
|
165
|
+
name: "RealismCraft",
|
|
166
|
+
creator: "Spark Universe",
|
|
167
|
+
},
|
|
168
|
+
spark_vfx: {
|
|
169
|
+
name: "Realism VFX",
|
|
170
|
+
creator: "Spark Universe",
|
|
171
|
+
},
|
|
172
|
+
spark_disasters: {
|
|
173
|
+
name: "Insane Disasters",
|
|
174
|
+
creator: "Spark Universe",
|
|
175
|
+
},
|
|
176
|
+
spark_amm1: {
|
|
177
|
+
name: "Lava Chicken Add-On",
|
|
178
|
+
creator: "Spark Universe",
|
|
179
|
+
},
|
|
180
|
+
spark_amm2: {
|
|
181
|
+
name: "A Minecraft Movie: Add-On",
|
|
182
|
+
creator: "Spark Universe",
|
|
183
|
+
},
|
|
184
|
+
spark_amm3: {
|
|
185
|
+
name: "A Minecraft Movie Jetpack Add-On",
|
|
186
|
+
creator: "Spark Universe",
|
|
187
|
+
},
|
|
188
|
+
spark_pets: {
|
|
189
|
+
name: "Spark Pets (Lite)",
|
|
190
|
+
creator: "Spark Universe",
|
|
191
|
+
},
|
|
192
|
+
spark_pets_pro: {
|
|
193
|
+
name: "Spark Pets (Premium)",
|
|
194
|
+
creator: "Spark Universe",
|
|
195
|
+
},
|
|
196
|
+
spark_spongebob: {
|
|
197
|
+
name: "SpongeBob SquarePants",
|
|
198
|
+
creator: "Spark Universe",
|
|
199
|
+
},
|
|
200
|
+
squaredreams_fhd: {
|
|
201
|
+
name: "Furniture HD",
|
|
202
|
+
creator: "Square Dreams",
|
|
203
|
+
},
|
|
204
|
+
squaredreams_realism: {
|
|
205
|
+
name: "Realism+",
|
|
206
|
+
creator: "Square Dreams",
|
|
207
|
+
},
|
|
208
|
+
squaredreams_bam: {
|
|
209
|
+
name: "Morph Into Anything",
|
|
210
|
+
creator: "Square Dreams",
|
|
211
|
+
},
|
|
212
|
+
stark_ep: {
|
|
213
|
+
name: "Enchantments Plus",
|
|
214
|
+
creator: "StarkTMA",
|
|
215
|
+
},
|
|
216
|
+
tm_aqc: {
|
|
217
|
+
name: "Aquaculture",
|
|
218
|
+
creator: "Team Metallurgy",
|
|
219
|
+
},
|
|
220
|
+
mb_af: {
|
|
221
|
+
name: "Auto Factory",
|
|
222
|
+
creator: "Team Metallurgy",
|
|
223
|
+
},
|
|
224
|
+
tomhmagic_realight: {
|
|
225
|
+
name: "Realight Reimagined",
|
|
226
|
+
creator: "Tomhmagic Creations",
|
|
227
|
+
},
|
|
228
|
+
thm_ecp: {
|
|
229
|
+
name: "Economy+",
|
|
230
|
+
creator: "Tomhmagic Creations",
|
|
231
|
+
},
|
|
232
|
+
thm_rmt: {
|
|
233
|
+
name: "Realm Management Tool",
|
|
234
|
+
creator: "Tomhmagic Creations",
|
|
235
|
+
},
|
|
236
|
+
ulkd_ess: {
|
|
237
|
+
name: "Essentials",
|
|
238
|
+
creator: "Unlinked",
|
|
239
|
+
},
|
|
240
|
+
ulkd_alch: {
|
|
241
|
+
name: "Alchemy",
|
|
242
|
+
creator: "Unlinked",
|
|
243
|
+
},
|
|
244
|
+
wypnt_ef: {
|
|
245
|
+
name: "Epic Fantasy",
|
|
246
|
+
creator: "Waypoint Studios",
|
|
247
|
+
},
|
|
248
|
+
xp_furniture: {
|
|
249
|
+
name: "Furniture",
|
|
250
|
+
creator: "XP GAMES",
|
|
251
|
+
},
|
|
252
|
+
xp_dl: {
|
|
253
|
+
name: "Dynamic Light",
|
|
254
|
+
creator: "XP GAMES",
|
|
255
|
+
},
|
|
256
|
+
xp_cd: {
|
|
257
|
+
name: "Cave Dweller",
|
|
258
|
+
creator: "XP GAMES",
|
|
259
|
+
},
|
|
260
|
+
};
|