Skip to content

Commit 953425b

Browse files
committed
Add documenation for modded generators
1 parent 20498e8 commit 953425b

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# misode.github.io
2-
Data Pack Generators and Guides for Minecraft Java Edition
2+
> Data Pack Generators for Minecraft Java Edition
33
44
https://misode.github.io/
55

@@ -24,6 +24,15 @@ misode.github.io supports multiple languages. If you'd like to help us translate
2424
3. See the components of misode.github.io [here](https://weblate.spyglassmc.com/projects/misode-github-io/web-app/).
2525
4. Start translating!
2626

27+
## Modded Generators
28+
This website contains a few [non-vanilla generators](https://misode.github.io/predicate/). It is possible to contribute additional generators. If instead you are interested in making custom generators but don't want them part of the main website, see the [forking section](#forking) below.
29+
30+
1. Create a new file `public/mcdoc/<your_project>.mcdoc`. This will contain the definitions of the
31+
2. Create a new generator entry in the `src/app/config.json` file for each generator page that you want to add. Set its `dependency` field to the name of the mcdoc file you created.
32+
3. Add translation key for each generator in `src/locales/en.json`, named `generator.<id>`, and a translation key named `partner.<dependency>`.
33+
4. The final step will be to write the generator definitions in the mcdoc file. Apart from the [technical specification](https://spyglassmc.com/user/mcdoc/), there is no documentation for the mcdoc format. It is a custom language describing JSON and NBT structures in the game. I recommend taking a look at how the other modded generators have their types. You can also look at the [vanilla mcdoc definitions](https://github.com/SpyglassMC/vanilla-mcdoc).
34+
5. Feel free to open a PR even when you are not ready with the types, or if you want help with writing them.
35+
2736
## Forking
2837
You are allowed to fork this repository and use its base as a way to publish your own generator site, but I ask to make a few changes before publishing.
2938

0 commit comments

Comments
 (0)