diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -6,6 +6,7 @@ The mod itself does not provide any help texts, just the framework. Current version: 0.5.0 ## For users +### Accessing the help To open the help, there are multiple ways: - Say “/help” in chat. This always works. @@ -16,6 +17,16 @@ The documentation system itself should be more or less self-explanatory. This mod is useless on its own, you will only need this mod as a dependency for mods which actually add some help entries. +### Hidden entries +Some entries are initially hidden from you. You can't see them until you +unlocked them. Mods can decide for themselves how particular entries are +revealed. Normally you just have to proceed in the game to unlock more +entries. Hidden entries exist to avoid spoilers and give players a small +sense of progress. + +Players with the `doc_reveal` privilege can use the `doc_reveal` chat command +to reveal all hidden entries instantly. + ## For modders and subgame authors This mod helps you in writing extensive documentation for your mod or subgame. You can write about basically anything in the presentation you prefer. |