From 696b5ae925c61a1bd70a1cfd664717621eb8f1f1 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Fri, 18 Nov 2016 14:52:36 +0100 Subject: Refer to other mods in README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 141cd13..21572c5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Current version: 0.7.0 ### Accessing the help To open the help, there are multiple ways: -- Use the `doc` chat command. This works always. +- Use the `/doc` chat command. This works always. - If you use Unified Inventory, click on the book icon in the inventory menu The documentation system itself should be more or less self-explanatory. @@ -24,15 +24,18 @@ 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 +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. To get started, read `API.md` in the directory of this mod. +Note: If you want to add help texts for items and nodes, refer to the API +documentation of `doc_items`, instead of manually adding entries. For +custom entities, you may also want to add support for `doc_identifier`. + ## License of everything MIT License -- cgit v1.2.3