mirror of
https://codeberg.org/AntumLuanti/mod-cleaner.git
synced 2025-03-15 04:41:22 +00:00
LDoc: add world path config file usage to HTML docs
This commit is contained in:
parent
4c5069447c
commit
e0bf9a56e6
3 changed files with 54 additions and 1 deletions
1
TODO.txt
1
TODO.txt
|
@ -8,6 +8,5 @@ TODO:
|
|||
- add "radius" option for pencil or "xlen", "ylen", & "zlen" options
|
||||
- add "xrotate" & "zrorate" modes for pencil
|
||||
- fix pencil "write" mode when pointing to side of node (node gets placed below)
|
||||
- add config file usage to HTML docs
|
||||
- move HTML docs to gh-pages branch
|
||||
- change "cleaner" chat command to something like "cleanertool" or "ctool"
|
||||
|
|
|
@ -20,6 +20,7 @@ file = {
|
|||
"api.lua",
|
||||
"chat.lua",
|
||||
"tools.lua",
|
||||
"docs/config.luadoc",
|
||||
}
|
||||
|
||||
new_type("chatcmd", "Chat Commands")
|
||||
|
|
53
docs/config.luadoc
Normal file
53
docs/config.luadoc
Normal file
|
@ -0,0 +1,53 @@
|
|||
|
||||
--- World Path Configuration
|
||||
--
|
||||
-- @topic config
|
||||
|
||||
|
||||
--- Main configuration file.
|
||||
--
|
||||
-- Registering items, entities, etc. for cleaning can be done in ***cleaner.json***
|
||||
-- in the world directory (`<world_path>/cleaner.json`). If it does not exist
|
||||
-- it will be created automatically when the server is started.
|
||||
--
|
||||
-- It is formatted as follows:
|
||||
--
|
||||
-- {
|
||||
-- "entities" :
|
||||
-- {
|
||||
-- "remove" : []
|
||||
-- },
|
||||
-- "items" :
|
||||
-- {
|
||||
-- "replace" : {}
|
||||
-- },
|
||||
-- "nodes" :
|
||||
-- {
|
||||
-- "remove" : [],
|
||||
-- "replace" : {}
|
||||
-- },
|
||||
-- "ores" :
|
||||
-- {
|
||||
-- "remove" : []
|
||||
-- }
|
||||
-- }
|
||||
--
|
||||
-- `remove` key works for nodes, entities, & ores. `replace` key works for
|
||||
-- nodes & items. Their functions are self-explanatory.
|
||||
--
|
||||
-- @json cleaner.json
|
||||
-- @usage
|
||||
-- Cleaning nodes example:
|
||||
-- {
|
||||
-- "nodes" :
|
||||
-- {
|
||||
-- "remove" : [
|
||||
-- "old:node_1",
|
||||
-- "old:node_2",
|
||||
-- ],
|
||||
-- "replace" : {
|
||||
-- "old:node_3" : "new:node_1",
|
||||
-- "old:node_4" : "new:node_2",
|
||||
-- }
|
||||
-- },
|
||||
-- }
|
Loading…
Add table
Reference in a new issue