You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# misode.github.io
2
-
Data Pack Generators and Guides for Minecraft Java Edition
2
+
> Data Pack Generators for Minecraft Java Edition
3
3
4
4
https://misode.github.io/
5
5
@@ -24,6 +24,15 @@ misode.github.io supports multiple languages. If you'd like to help us translate
24
24
3. See the components of misode.github.io [here](https://weblate.spyglassmc.com/projects/misode-github-io/web-app/).
25
25
4. Start translating!
26
26
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
+
27
36
## Forking
28
37
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.
0 commit comments