README.md

   1 # Help
   2 The goal of this modpack is to make using Minetest and mods easier for both
   3 newcomers and advanced users.
   4 It makes it easier for newcomers by making help more accessible.
   5 It makes life easier for advanced user by making it more convenient to use, by
   6 centralizing the help where you most need it: Inside the game. This modpack
   7 will also make the life of modder easier by allowing them to add help texts
   8 directly into mods (via `doc_items`).
   9
  10 More information is given in the respective mods.
  11
  12 Overview of the mods:
  13
  14 * `doc`: Documentation System. Core API and user interface. Mods can add arbitrary categories and entries
  15 * `doc_basics`: Basic Help. Adds basic help texts about Minetest, controls, gameplay and other basics
  16 * `doc_items`: Item Help. Adds automatically generated help texts for items and an API
  17 * `doc_encyclopedia`: Encyclopedia. An item to access the help
  18 * `doc_identifier`: Lookup Tool. A tool to identify and show help texts for pointed things
  19
  20 ## How to clone (Information for developers)
  21
  22 This repository does not directly include the mods,
  23 but as [https://git-scm.com/book/en/v2/Git-Tools-Submodules](Git submodules) instead.
  24
  25 You can use the following command to clone this repository and get all its submodules:
  26
  27     git clone http://repo.or.cz/minetest_doc_modpack.git --recurse-submodules
  28
  29 Consult the Git help to learn more about working with submodules.