Wuzzy
/
minetest_doc_example
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
11 Commits
1 Branch
0 Tags
452 KiB
Lua 100%
 
Go to file
Wuzzy 40f4f3008d Update description 2016-12-20 12:19:59 +01:00
README.md Add doc_identifier example 2016-12-19 19:00:52 +01:00
depends.txt Add doc_identifier example 2016-12-19 19:00:52 +01:00
description.txt Update description 2016-12-20 12:19:59 +01:00
doc.lua Add doc_identifier example 2016-12-19 19:00:52 +01:00
doc_identifier.lua Add doc_identifier example 2016-12-19 19:00:52 +01:00
doc_items.lua Update doc_items helptexts 2016-12-20 12:19:21 +01:00
init.lua Add doc_identifier example 2016-12-19 19:00:52 +01:00
mod.conf Initial commit 2016-12-15 23:27:11 +01:00

README.md

Example mod for Help modpack (doc, doc_items, etc.)

This mod is for modders and useless for anyone else. It demonstrates the usage of the APIs of the Help mods. This should help you in getting started with this modpack.

Using the APIs of the Help modpack helps to improve the overall quality and completeness of the entire help.

It includes examples for the following mods:

  • doc_items: In doc_items.lua, for item help. Start here!
  • doc_identifier: In doc_identifier.lua, for adding lookup tool support for custom entities
  • doc: In doc.lua, for adding your own categories. For advanced modding

Activate this mod in your world to see some example categories, entries and items added.

Read the source code for some brief explanation.

THIS IS NOT A FULL EXAMPLE. Please read API.md of the respective mods to learn how to use the mod properly.