minetest_doc_modpack/README.md

32 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

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