Skip to content

Commit f10a1dd

Browse files
QuazChickQuazChick
authored
Update style-guide.md
1 parent 7a3e3cd commit f10a1dd

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

‎docs/meta/style-guide.md

+33-31
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Style Guide
3+
description: A guide for keeping Minecraft creations consistent.
34
mentions:
45
- SirLich
56
- solvedDev
67
- MedicalJewel105
78
- ChibiMango
89
- zheaEvyline
910
- QuazChick
10-
description: Officially supported Bedrock Wiki style guide for add-on creation.
1111
---
1212

13-
This document will present the officially supported Bedrock Wiki style guide for add-on creation. This guide aims to promote best practices while creating add-ons and create a consistent format for everyone to follow.
13+
This document will present the Bedrock Wiki style guide for add-on creation. This guide aims to promote best practices while creating add-ons and create a consistent format for everyone to follow.
1414

1515
:::tip
1616
The style guide is a living, breathing document, which will evolve as add-on creation evolves. Please get in touch if you think something needs to be updated or changed!
@@ -24,51 +24,55 @@ The style guide is a living, breathing document, which will evolve as add-on cre
2424
- Content folders should use consistent pluralization: Stick with names that are either all plural or all singular, don't mix and match. Example:
2525

2626
✅️ Consistent:
27+
2728
```
2829
BP/functions/abilities/ice_blast.mcfunction
2930
BP/functions/events/player/on_death.mcfunction
3031
BP/functions/events/world/on_initialise.mcfunction
3132
BP/functions/quests/jungle/1.mcfunction
3233
```
33-
- All content folders `abilities`, `events`, and `quests` are consistently pluralized.
34-
- The content folders in `events` are also consistent, as both `player` and `world` are singular.
34+
35+
- All content folders `abilities`, `events`, and `quests` are consistently pluralized.
36+
- The content folders in `events` are also consistent, as both `player` and `world` are singular.
3537

3638
❌️ Inconsistent:
39+
3740
```
3841
BP/functions/ability/ice_blast.mcfunction
3942
BP/functions/event/players/on_death.mcfunction
4043
BP/functions/event/world/on_initialise.mcfunction
4144
BP/functions/quests/jungle/1.mcfunction
4245
```
43-
- Only `quests` content folder is pluralized while `ability`, and `event` are singular.
44-
- Also, in the `event` folder, the `players` folder is plural while `world` is singular.
46+
47+
- Only `quests` content folder is pluralized while `ability`, and `event` are singular.
48+
- Also, in the `event` folder, the `players` folder is plural while `world` is singular.
4549

4650
## Identifiers
4751

4852
Do not use identifiers that begin with a number, and especially don't use an identifier that is _only_ a number. This applies to entities, component_groups, events, and anything else that takes a `namespace:name` pair.
4953

5054
## File and Folder Names
5155

52-
| Concept | Example Identifier |
53-
| -------------------- | -------------------------- |
54-
| Behavior Pack | dragons_BP |
55-
| Resource Pack | dragons_RP |
56-
| Geometry | dragon.geo.json |
57-
| Animation | dragon.animation.json |
58-
| Animation Controller | dragon.ac.json |
59-
| RP Entity | dragon.ce.json<br>*(ce: client entity)*|
60-
| BP Entity | dragon.se.json<br>*(se: server entity)*|
61-
| Item 1.16.100+ | dragon_tooth.item.json |
62-
| BP Item | dragon_tooth.item.bp.json |
63-
| RP Item | dragon_tooth.item.rp.json |
64-
| Render Controller | dragon.rc.json |
65-
| Loot Table | dragon.loot.json |
66-
| Recipe | dragon_saddle.recipe.json |
67-
| Spawn Rules | dragon.spawn.json |
68-
| Trade Table | dragon.trade.json |
69-
| Particles | dragon_magic.particle.json |
70-
| Texture | dragon.png |
71-
| Gametest | dragonTest.js |
56+
| Concept | Example |
57+
| --------------------- | ----------------------------------------------------------------- |
58+
| Behavior Pack | dragons_BP |
59+
| Resource Pack | dragons_RP |
60+
| Geometry | dragon.geo.json |
61+
| Animations | dragon.animation.json<br>dragon.anim.json |
62+
| Animation Controllers | dragon.animation_controllers.json<br>dragon.ac.json |
63+
| RP Entity | dragon.entity.json<br>dragon.client_entity.json<br>dragon.ce.json |
64+
| BP Entity | dragon.behavior.json<br>dragon.se.json<br>*(se: server entity)* |
65+
| Item | dragon_tooth.item.json |
66+
| Legacy Item (BP) | dragon_tooth.item.bp.json |
67+
| Legacy Item (RP) | dragon_tooth.item.rp.json |
68+
| Render Controllers | dragon.render_controllers.json<br>dragon.rc.json |
69+
| Loot Table | dragon.json |
70+
| Recipe | dragon_saddle.recipe.json |
71+
| Spawn Rules | dragon.spawn.json |
72+
| Trade Table | dragon.json |
73+
| Particles | dragon_magic.particle.json |
74+
| Texture | dragon.png |
75+
| Script | dragonFlight.js |
7276

7377
## Namespaces
7478

@@ -84,12 +88,12 @@ Where to use namespaces:
8488

8589
- entities
8690
- particles
87-
- component-groups
91+
- component groups
8892
- events
8993

9094
When not to use namespaces:
9195

92-
- do not include your namespace in any folder path or file-name
96+
- do not include your namespace in any folder path or file name
9397

9498
## Sub-Indexing
9599

@@ -273,8 +277,8 @@ Own-line comments can be used for organizational purposes but should not store l
273277
| BDS | Bedrock Dedicated Server |
274278
| FPV | First Person View |
275279
| RD | Render Dragon |
276-
| VSCode | Visual Studio Code |
277280
| SP | Skin Pack |
281+
| VSCode | Visual Studio Code |
278282

279283
## Definition Format Orders
280284

@@ -327,5 +331,3 @@ Blocks, entities and items should follow the format order below.
327331

328332
PascalCase should be used with `BlockComponent` or `ItemComponent` as a suffix. As an example, `const MeltableBlockComponent = { ... }` rather than `const meltable = { ... }`.
329333
This helps to differentiate what we're using in `registerCustomComponent` and what we're using as values elsewhere.
330-
331-

0 commit comments

Comments
 (0)