@bedrock-oss/add-on-registry 1.0.5 → 1.0.7

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 (3) hide show
  1. package/README.md +11 -3
  2. package/package.json +3 -2
  3. package/registry.js +174 -86
package/README.md CHANGED
@@ -1,17 +1,20 @@
1
1
  # Add-On Registry [![npm version](https://img.shields.io/npm/v/@bedrock-oss/add-on-registry)](https://www.npmjs.com/package/@bedrock-oss/add-on-registry)
2
+
2
3
  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
 
4
5
  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
 
6
-
7
7
  ## Contribution
8
+
8
9
  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
10
  Your pull-request will automatically merge all JSON files together into one file `registry.js` that is not tracked by Git but published to NPM.
10
11
 
11
12
  ### Steps
13
+
12
14
  1. Create a new JSON file or edit one inside the `/registry` folder.
13
15
  - If you're a "new" creator, the filename should be your creator/studio name (e.g. `ascent.json`, `spark.json`).
14
16
  2. Follow the structure used in the other files. Example:
17
+
15
18
  ```json
16
19
  {
17
20
  "ascent_paint": {
@@ -20,9 +23,11 @@ Your pull-request will automatically merge all JSON files together into one file
20
23
  }
21
24
  }
22
25
  ```
26
+
23
27
  3. Commit your JSON file, then open a pull request.
24
28
 
25
29
  ### Notes
30
+
26
31
  - The **key** should be the ID/namespace of your Add-On (the same namespace you use for blocks, entities, etc.).
27
32
  - `name`: Display name of your Add-On.
28
33
  - `creator`: Name of the creator or studio.
@@ -30,12 +35,15 @@ Your pull-request will automatically merge all JSON files together into one file
30
35
  - Please use 4 spaces for indentation in your JSON file for consistency across all creator files.
31
36
 
32
37
  ## Including it in your pack
38
+
33
39
  To use the registry in your project, install it via NPM from this repository:
34
- ```
40
+
41
+ ```bash
35
42
  npm i @bedrock-oss/add-on-registry
36
43
  ```
37
44
 
38
45
  You can now use it in your project like this:
46
+
39
47
  ```javascript
40
48
  import { Registry } from "@bedrock-oss/add-on-registry"
41
49
 
@@ -45,4 +53,4 @@ function getAddOnName(identifier) {
45
53
  // Use the namespace itself as fallback
46
54
  return entry ? entry.name : namespace;
47
55
  }
48
- ```
56
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bedrock-oss/add-on-registry",
3
- "version": "1.0.5",
3
+ "version": "1.0.7",
4
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
5
  "main": "registry.js",
6
6
  "type": "module",
@@ -19,7 +19,8 @@
19
19
  },
20
20
  "homepage": "https://github.com/Bedrock-OSS/add-on-registry#readme",
21
21
  "scripts": {
22
- "build": "node scripts/build-registry.js",
22
+ "validate": "node scripts/validate-registry.js",
23
+ "build": "npm run validate && node scripts/build-registry.js",
23
24
  "prepublishOnly": "npm run build"
24
25
  },
25
26
  "files": [
package/registry.js CHANGED
@@ -5,343 +5,431 @@
5
5
  * @type {import("./types").RegistryMap}
6
6
  */
7
7
  export const Registry = {
8
- andexsa: {
8
+ "andexsa": {
9
9
  name: "8Crafter's Entity Scale, NBT, and Behavior Modifier, Bossbar, and Morph Addon",
10
10
  creator: "8Crafter",
11
11
  },
12
- andexdb: {
12
+ "andexdb": {
13
13
  name: "8Crafter's Server Utilities & Debug Sticks",
14
14
  creator: "8Crafter",
15
15
  },
16
- andexrp: {
16
+ "andexrp": {
17
17
  name: "8Crafter's Entity Scale, NBT, and Behavior Modifier, Bossbar, and Morph Addon",
18
18
  creator: "8Crafter",
19
19
  },
20
- andexsl: {
20
+ "andexsl": {
21
21
  name: "8Crafter's Secret Items Loader",
22
22
  creator: "8Crafter",
23
23
  },
24
- aria_pp: {
24
+ "aria_pp": {
25
25
  name: "Planes Pro",
26
26
  creator: "AriaCreations",
27
27
  },
28
- ascent_paint: {
29
- name: "Paint",
28
+ "ascent_paint": {
29
+ name: "Paint Add-On",
30
30
  creator: "ASCENT",
31
31
  },
32
- bf_rb: {
32
+ "ascent_htcg": {
33
+ name: "Hermitcraft TCG Add-On",
34
+ creator: "Hermitcraft x ASCENT",
35
+ },
36
+ "bf_rb": {
33
37
  name: "Biomes",
34
38
  creator: "Block Factory",
35
39
  },
36
- bluemods: {
40
+ "bluemods": {
37
41
  name: "BlueMods Anticheat",
38
42
  creator: "BlueShadow",
39
43
  },
40
- cc_su: {
44
+ "cc_fairytales": {
45
+ name: "Fairy Tales",
46
+ creator: "Chillcraft Studios",
47
+ },
48
+ "cc_abyss": {
49
+ name: "Abyssal Echoes",
50
+ creator: "Chillcraft Studios",
51
+ },
52
+ "cc_mechs": {
53
+ name: "Mech Expansion",
54
+ creator: "Chillcraft Studios",
55
+ },
56
+ "cc_su": {
41
57
  name: "SCP: Uncaged Add-On",
42
58
  creator: "Cloud Corp",
43
59
  },
44
- darkosto_elemental_crops: {
60
+ "darkosto_elemental_crops": {
45
61
  name: "Elemental Crops",
46
62
  creator: "Darkosto",
47
63
  },
48
- float_fc: {
64
+ "float_fc": {
49
65
  name: "Forest Craft",
50
66
  creator: "Float Studios",
51
67
  },
52
- float_fca: {
68
+ "float_fca": {
53
69
  name: "Fur Craft",
54
70
  creator: "Float Studios",
55
71
  },
56
- float_br: {
72
+ "float_br": {
57
73
  name: "The Backrooms Add-On",
58
74
  creator: "Float Studios",
59
75
  },
60
- gm1_ord: {
76
+ "gm1_ord": {
61
77
  name: "Sonic",
62
78
  creator: "Gamemode One",
63
79
  },
64
- gm1_zen: {
80
+ "gm1_zen": {
65
81
  name: "How to Train Your Dragon",
66
82
  creator: "Gamemode One",
67
83
  },
68
- gds_icu: {
84
+ "gds_icu": {
69
85
  name: "Combat Utilities",
70
86
  creator: "Glowfischdesigns",
71
87
  },
72
- gds_we: {
88
+ "gds_we": {
73
89
  name: "World Editing",
74
90
  creator: "Glowfischdesigns",
75
91
  },
76
- hf_mzs: {
92
+ "hf_mzs": {
77
93
  name: "Mowzie’s Mobs",
78
94
  creator: "Honeyfrost",
79
95
  },
80
- jm: {
96
+ "jm": {
81
97
  name: "jeanmajid",
82
98
  creator: "jeanmajid",
83
99
  },
84
- jig_atw: {
100
+ "jig_atw": {
85
101
  name: "ALL THE WOOL",
86
102
  creator: "Jigarbov Productions",
87
103
  },
88
- jig_bmu: {
104
+ "jig_bmu": {
89
105
  name: "Battle Mutants",
90
106
  creator: "Jigarbov Productions",
91
107
  },
92
- jig_ccomp: {
108
+ "jig_ccomp": {
93
109
  name: "Computers",
94
110
  creator: "Jigarbov Productions",
95
111
  },
96
- jig_mtd: {
112
+ "jig_mtd": {
97
113
  name: "Detect-Ore",
98
114
  creator: "Jigarbov Productions",
99
115
  },
100
- jig_pcs: {
116
+ "jig_pcs": {
101
117
  name: "Papercraft Mob Stickers",
102
118
  creator: "Jigarbov Productions",
103
119
  },
104
- jig_pco: {
120
+ "jig_pco": {
105
121
  name: "Advanced Compass",
106
122
  creator: "Jigarbov Productions",
107
123
  },
108
- jig_poip: {
124
+ "jig_poip": {
109
125
  name: "Poisonous Potato",
110
126
  creator: "Jigarbov Productions",
111
127
  },
112
- jig_teta: {
128
+ "jig_teta": {
113
129
  name: "Tetris® Add-On",
114
130
  creator: "Jigarbov Productions",
115
131
  },
116
- jig_common: {
132
+ "jig_common": {
117
133
  name: "Cross-AddOn Jigarbov Pack",
118
134
  creator: "Jigarbov Productions",
119
135
  },
120
- mco_tde: {
136
+ "mobpie_furn": {
137
+ name: "Furniture Add-On",
138
+ creator: "Mob Pie",
139
+ },
140
+ "mobpie_animal": {
141
+ name: "Animals Add-On",
142
+ creator: "Mob Pie",
143
+ },
144
+ "mobpie_cars": {
145
+ name: "Luxury Cars Add-On",
146
+ creator: "Mob Pie",
147
+ },
148
+ "mobpie_doors": {
149
+ name: "Secret Doors Add-On",
150
+ creator: "Mob Pie",
151
+ },
152
+ "mco_tde": {
121
153
  name: "The Dawn Era",
122
154
  creator: "Mush Co",
123
155
  },
124
- nps_mot: {
156
+ "nps_mot": {
125
157
  name: "More Ores and Tools",
126
158
  creator: "Netherpixel",
127
159
  },
128
- oreville_15yr: {
160
+ "oreville_15yr": {
129
161
  name: "15 Year Party Supplies",
130
162
  creator: "Oreville Studios",
131
163
  },
132
- oreville_vm: {
164
+ "oreville_vm": {
133
165
  name: "Vibrant Memories Add-On",
134
166
  creator: "Oreville Studios",
135
167
  },
136
- oreville_rb: {
168
+ "oreville_rb": {
137
169
  name: "Realistic Biomes Add-On",
138
170
  creator: "Oreville Studios",
139
171
  },
140
- oreville_tc: {
172
+ "oreville_tc": {
141
173
  name: "Time Capsule Add-On",
142
174
  creator: "Oreville Studios",
143
175
  },
144
- oreville_wb: {
176
+ "oreville_wb": {
145
177
  name: "World Builder Add-On",
146
178
  creator: "Oreville Studios",
147
179
  },
148
- oreville_hp: {
180
+ "oreville_hp": {
149
181
  name: "Health Bars Add-On",
150
182
  creator: "Oreville Studios",
151
183
  },
152
- pu_biomes: {
184
+ "pu_biomes": {
153
185
  name: "MORE BIOMES Add-On",
154
186
  creator: "Pixelusion",
155
187
  },
156
- pu_bn: {
188
+ "pu_bn": {
157
189
  name: "BURNT Add-On",
158
190
  creator: "Pixelusion",
159
191
  },
160
- pu_blasters: {
192
+ "pu_blasters": {
161
193
  name: "BLASTERS Add-On",
162
194
  creator: "Pixelusion",
163
195
  },
164
- pixelusion_dbp: {
196
+ "pixelusion_dbp": {
165
197
  name: "PORTAL BACKPACKS Add-On",
166
198
  creator: "Pixelusion",
167
199
  },
168
- pixelusion_td: {
200
+ "pixelusion_td": {
169
201
  name: "Training Dummies Add-On",
170
202
  creator: "Pixelusion",
171
203
  },
172
- pu_se: {
204
+ "pu_se": {
173
205
  name: "SHIELDS Add-On",
174
206
  creator: "Pixelusion",
175
207
  },
176
- pod_farm: {
208
+ "pod_farm": {
177
209
  name: "FARMING",
178
210
  creator: "Podcrash",
179
211
  },
180
- pod_gard: {
212
+ "pod_gard": {
181
213
  name: "GARDENING",
182
214
  creator: "Podcrash",
183
215
  },
184
- pod_engi: {
216
+ "pod_engi": {
185
217
  name: "MACHINES",
186
218
  creator: "Podcrash",
187
219
  },
188
- pod_rpg: {
220
+ "pod_rpg": {
189
221
  name: "RPG SKILLS",
190
222
  creator: "Podcrash",
191
223
  },
192
- pod_trn: {
224
+ "pod_trn": {
193
225
  name: "TRAINS",
194
226
  creator: "Podcrash",
195
227
  },
196
- httyd: {
228
+ "httyd": {
197
229
  name: "Age of Berk",
198
230
  creator: "S3XT4 Studios",
199
231
  },
200
- sqst_bkpk: {
232
+ "sqst_bkpk": {
201
233
  name: "Backpacks",
202
234
  creator: "Scai Quest",
203
235
  },
204
- sqst_ihfs: {
236
+ "sqst_ihfs": {
205
237
  name: "AutoFisher",
206
238
  creator: "Scai Quest",
207
239
  },
208
- sqst_oreb: {
240
+ "sqst_oreb": {
209
241
  name: "Ore Beetles",
210
242
  creator: "Scai Quest",
211
243
  },
212
- sqst_plsh: {
244
+ "sqst_plsh": {
213
245
  name: "Plushies",
214
246
  creator: "Scai Quest",
215
247
  },
216
- sqst_xpcb: {
248
+ "sqst_xpcb": {
217
249
  name: "XP Crystal Bank",
218
250
  creator: "Scai Quest",
219
251
  },
220
- sqst_mtls: {
252
+ "sqst_mtls": {
221
253
  name: "Multitool",
222
254
  creator: "Scai Quest",
223
255
  },
224
- shapescape_ext: {
256
+ "shapescape_ext": {
225
257
  name: "The Extinct",
226
258
  creator: "Shapescape",
227
259
  },
228
- spark_portals: {
260
+ "spark_portals": {
229
261
  name: "Spark Portals",
230
262
  creator: "Spark Universe",
231
263
  },
232
- spark: {
264
+ "spark": {
233
265
  name: "RealismCraft",
234
266
  creator: "Spark Universe",
235
267
  },
236
- spark_vfx: {
268
+ "spark_vfx": {
237
269
  name: "Realism VFX",
238
270
  creator: "Spark Universe",
239
271
  },
240
- spark_disasters: {
272
+ "spark_disasters": {
241
273
  name: "Insane Disasters",
242
274
  creator: "Spark Universe",
243
275
  },
244
- spark_amm1: {
276
+ "spark_amm1": {
245
277
  name: "Lava Chicken Add-On",
246
278
  creator: "Spark Universe",
247
279
  },
248
- spark_amm2: {
280
+ "spark_amm2": {
249
281
  name: "A Minecraft Movie: Add-On",
250
282
  creator: "Spark Universe",
251
283
  },
252
- spark_amm3: {
284
+ "spark_amm3": {
253
285
  name: "A Minecraft Movie Jetpack Add-On",
254
286
  creator: "Spark Universe",
255
287
  },
256
- spark_pets: {
288
+ "spark_pets": {
257
289
  name: "Spark Pets (Lite)",
258
290
  creator: "Spark Universe",
259
291
  },
260
- spark_pets_pro: {
292
+ "spark_pets_pro": {
261
293
  name: "Spark Pets (Premium)",
262
294
  creator: "Spark Universe",
263
295
  },
264
- spark_spongebob: {
296
+ "spark_spongebob": {
265
297
  name: "SpongeBob SquarePants",
266
298
  creator: "Spark Universe",
267
299
  },
268
- squaredreams_fhd: {
300
+ "squaredreams_fhd": {
269
301
  name: "Furniture HD",
270
302
  creator: "Square Dreams",
271
303
  },
272
- squaredreams_realism: {
304
+ "squaredreams_realism": {
273
305
  name: "Realism+",
274
306
  creator: "Square Dreams",
275
307
  },
276
- squaredreams_bam: {
308
+ "squaredreams_bam": {
277
309
  name: "Morph Into Anything",
278
310
  creator: "Square Dreams",
279
311
  },
280
- stark_ep: {
312
+ "sf_gaa": {
313
+ name: "McDonald's Add-On",
314
+ creator: "Starfish Studios",
315
+ },
316
+ "sf_cma": {
317
+ name: "CRAFTYMON",
318
+ creator: "Starfish Studios",
319
+ },
320
+ "sf_hba": {
321
+ name: "Hamsters+",
322
+ creator: "Starfish Studios",
323
+ },
324
+ "sf_scp": {
325
+ name: "Can You Survive?",
326
+ creator: "Starfish Studios",
327
+ },
328
+ "sf_hei": {
329
+ name: "Moana 2",
330
+ creator: "Starfish Studios",
331
+ },
332
+ "sf_afm": {
333
+ name: "Another Furniture",
334
+ creator: "Starfish Studios",
335
+ },
336
+ "sf_nba": {
337
+ name: "Naturalist",
338
+ creator: "Starfish Studios",
339
+ },
340
+ "sf.baby_dragons": {
341
+ name: "DRAGON PETS",
342
+ creator: "Starfish Studios",
343
+ },
344
+ "stark_ep": {
281
345
  name: "Enchantments Plus",
282
346
  creator: "StarkTMA",
283
347
  },
284
- tm_aqc: {
348
+ "tm_aqc": {
285
349
  name: "Aquaculture",
286
350
  creator: "Team Metallurgy",
287
351
  },
288
- mb_af: {
352
+ "mb_af": {
289
353
  name: "Auto Factory",
290
354
  creator: "Team Metallurgy",
291
355
  },
292
- tep_lm: {
356
+ "tep_lm": {
293
357
  name: "LUNAR MOON Add-On",
294
358
  creator: "Teplight",
295
359
  },
296
- twf_jb: {
360
+ "twf_jb": {
297
361
  name: "Chomp",
298
362
  creator: "The World Foundry",
299
363
  },
300
- twfae_cos: {
364
+ "twfae_cos": {
301
365
  name: "Lamp Lights",
302
366
  creator: "The World Foundry",
303
367
  },
304
- twf_bmt: {
368
+ "twf_bmt": {
305
369
  name: "Bubble",
306
370
  creator: "The World Foundry",
307
371
  },
308
- twf_calm: {
372
+ "twf_calm": {
309
373
  name: "C.A.L.M.",
310
374
  creator: "The World Foundry",
311
375
  },
312
- tomhmagic_realight: {
376
+ "snst_bckp": {
377
+ name: "Backpacks++",
378
+ creator: "ThunderAy",
379
+ },
380
+ "snst_morph": {
381
+ name: "BE a MOB",
382
+ creator: "ThunderAy",
383
+ },
384
+ "tomhmagic_realight": {
313
385
  name: "Realight Reimagined",
314
386
  creator: "Tomhmagic Creations",
315
387
  },
316
- thm_ecp: {
388
+ "thm_ecp": {
317
389
  name: "Economy+",
318
390
  creator: "Tomhmagic Creations",
319
391
  },
320
- thm_rmt: {
392
+ "thm_rmt": {
321
393
  name: "Realm Management Tool",
322
394
  creator: "Tomhmagic Creations",
323
395
  },
324
- ulkd_ess: {
396
+ "ulkd_ess": {
325
397
  name: "Essentials",
326
398
  creator: "Unlinked",
327
399
  },
328
- ulkd_alch: {
400
+ "ulkd_alch": {
329
401
  name: "Alchemy",
330
402
  creator: "Unlinked",
331
403
  },
332
- wypnt_ef: {
404
+ "wypnt_ef": {
333
405
  name: "Epic Fantasy",
334
406
  creator: "Waypoint Studios",
335
407
  },
336
- xp_furniture: {
408
+ "wonder_tech": {
409
+ name: "Advanced Machines Add-On",
410
+ creator: "Wonder",
411
+ },
412
+ "wonder_aps": {
413
+ name: "Advanced Power Suits Add-On",
414
+ creator: "Wonder",
415
+ },
416
+ "wonder_cons": {
417
+ name: "Construction Add-On",
418
+ creator: "Wonder",
419
+ },
420
+ "wonder_ores": {
421
+ name: "More Ores Tools Armor Add-On",
422
+ creator: "Wonder",
423
+ },
424
+ "xp_furniture": {
337
425
  name: "Furniture",
338
426
  creator: "XP GAMES",
339
427
  },
340
- xp_dl: {
428
+ "xp_dl": {
341
429
  name: "Dynamic Light",
342
430
  creator: "XP GAMES",
343
431
  },
344
- xp_cd: {
432
+ "xp_cd": {
345
433
  name: "Cave Dweller",
346
434
  creator: "XP GAMES",
347
435
  },