mods/HELP/doc/doc/README.md

   1 # Documentation System [`doc`]
   2 This mod provides a simple and highly extensible form in which the user
   3 can access help pages about various things and the modder can add those pages.
   4 The mod itself does not provide any help texts, just the framework.
   5 It is the heart of the Help modpack, on which the other Help mods depend.
   6
   7 Current version: 1.1.1
   8
   9 ## For players
  10 ### Accessing the help
  11 To open the help, there are multiple ways:
  12
  13 - Use the `/helpform` chat command. This works always.
  14 - If you use one of these mods, there's a help button in the inventory menu:
  15     - Unified Inventory [`unified_inventory`]
  16     - Simple Fast Inventory Buttons [`sfinv_buttons`]
  17     - Inventory++ [`inventory_plus`]
  18
  19 The help itself should be more or less self-explanatory.
  20
  21 This mod is useless on its own, you will only need this mod as a dependency
  22 for mods which actually add some help entries.
  23
  24 ### Hidden entries
  25 Some entries are initially hidden from you. You can't see them until you
  26 unlocked them. Mods can decide for themselves how particular entries are
  27 revealed. Normally you just have to proceed in the game to unlock more
  28 entries. Hidden entries exist to avoid spoilers and give players a small
  29 sense of progress.
  30
  31 Players with the `help_reveal` privilege can use the `/help_reveal` chat
  32 command to reveal all hidden entries instantly.
  33
  34 ### Maintenance
  35 The information of which player has viewed and revealed which entries is
  36 stored in the world directory in the file `doc.mt`. You can safely reset
  37 the viewed/revealed state of all players by deleting this file. Players
  38 then need to start over revealing all entries.
  39
  40 ## For modders and game authors
  41 This mod helps you in creating extensive and flexible help entries for your
  42 mods or game. You can write about basically anything in the presentation
  43 you prefer.
  44
  45 To get started, read `API.md` in the directory of this mod.
  46
  47 Note: If you want to add help texts for items and nodes, refer to the API
  48 documentation of `doc_items`, instead of manually adding entries.
  49 For custom entities, you may also want to add support for `doc_identifier`.
  50
  51 ## License of everything
  52 MIT License