mini-mammoth / celtic-rituals

Minecraft Mod for 1.14 - Sacrifice mobs to please the gods and become a strong druid
MIT License
3 stars 0 forks source link

Documentation #27

Open reicheltp opened 4 years ago

reicheltp commented 4 years ago

Create a fancy website with mod docs for the ~enduser~ players.

reicheltp commented 4 years ago

May this can help to render recipes: https://minerender.org/

reicheltp commented 4 years ago

Thought of something super easy like: https://www.docz.site/

sebkasanzew commented 4 years ago

Create a fancy website with mod docs for the enduser.

What endusers are you referring to? Do you mean potential contributors, or players of the mod in Minecraft?

If you mean the players: should all recepies be documented, or should some stay a "secret" for figuring them out by try and error for playability?

reicheltp commented 4 years ago

Primarily player docs. For contributors we should keep and update README and CONTRIBUTION guide.

I also could imagine it would be nice to have the docs for custom recipes public as this empowers prosumer and modpack creators.

reicheltp commented 4 years ago

If you mean the players: should all recepies be documented, or should some stay a "secret" for figuring them out by try and error for playability?

We should document all recipes that are static and available to all users (see also #36)

We can add dynamically generated recipes in the future which are not "static". But also there should be documented where the required ingredients are picked from.

reicheltp commented 4 years ago

We can also use JEI to add ingame documentation for core mechanics. This should at least include:

See: https://github.com/mezz/JustEnoughItems/wiki/Recipes-Overview#modded-recipe-implementation