search

cocolabs / odyssey

Minecraft Forge desert themed survival/adventure mod.
MIT License
0 stars 1 forks source link

Add wiki documentation #11

Open matshou opened 4 years ago

matshou commented 4 years ago

We should start documenting all mod mechanics in the repository wiki.

matshou commented 4 years ago

@Titus-Armillius I think this is a good task for you to do on a continuous basis as we are discussing things and slowly implementing them. Read more about Github wikis if you are not familiar with them.

ghost commented 4 years ago

@yooksi I've looked at a few tutorials and the Github documentation, but could not find much information on why the 'wiki' tab in the repository is not visible for me.

What I could find suggested that the creator of the repository might need to change some visibility setting.

Could you take a look?

matshou commented 4 years ago

Upgrade or make this repository public to enable Wikis

GitHub Wikis is a simple way to let others contribute content. Any GitHub user can create and edit pages to use for documentation, examples, support, or anything you wish.

Apparently we need to make the repository public to enable the wiki feature. I didn't know about this since I've only recently started working with private repositories, I tend to keep my code public.

Do you have any objections to us opening up the repository to the public?

ghost commented 4 years ago

I'm fine with it.

matshou commented 4 years ago

Done, the wiki tab should now be visible.

matshou commented 4 years ago

@Titus-Armillius Could we get the day/night cycle documentation up on the wiki now that we've implemented that mechanic in our first pre-release?

ghost commented 4 years ago

@yooksi I'll add the day/night cycle documentation asap.

Just to be sure; is the number value in the config a multiple? e.g. -12 = 12x slower?

matshou commented 4 years ago

Yes, that is correct. See TimeCycle javadoc for more information.