From b5f0c90986e9baaf2c6172db11a9543a5f84dc3d Mon Sep 17 00:00:00 2001 From: solebull Date: Wed, 7 Jul 2021 16:50:23 +0200 Subject: [PATCH] Fix some mods doxygen related page --- Makefile | 1 + README.md | 7 ++++- ROADMAP | 8 +++-- TODO | 3 +- mods/bonemeal/{LICENSE.md => LICENSE.txt} | 0 mods/bonemeal/README.md | 12 +++++++ mods/caches/README.md | 38 ++++++++++++++++++++++- mods/caches/readme.txt | 35 --------------------- mods/caverealms/README.md | 7 +++-- 9 files changed, 68 insertions(+), 43 deletions(-) rename mods/bonemeal/{LICENSE.md => LICENSE.txt} (100%) create mode 100644 mods/bonemeal/README.md delete mode 100644 mods/caches/readme.txt diff --git a/Makefile b/Makefile index 0061b48..46d0f05 100644 --- a/Makefile +++ b/Makefile @@ -2,3 +2,4 @@ doc: luadoc -d doc/ mods + doxygen diff --git a/README.md b/README.md index 26270a4..6ff6d7d 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,11 @@ Allez dans le répertoire minetest/games/ puis : Et eventuellement, un mode d'edition `emacs` : `sudo apt install lua-mode`. +## Débogage + +Pour cycler sur les différents écrans de déboguage, presser F5. L'affichage en +wireframe peut être très utile. + ### Documentation J'essaye de documenter tant que possible le code des mods. La documentation @@ -43,7 +48,7 @@ puis doxygen -puis ouvrir html/index.html. +puis ouvrir `html/index.html`. ## En tant qu'administrateur diff --git a/ROADMAP b/ROADMAP index 2d84f9d..344950e 100644 --- a/ROADMAP +++ b/ROADMAP @@ -259,13 +259,14 @@ mods/pathogen/gravititus/init.lua:36: attempt to index local 'digger' (a nil val Or have a new ore named after him - [ ] Make a new mod called spawn Maybe used with https://github.com/octacian/spawnpoint -**** To-be-reprocudes bugs +**** To-be-reprocuded bugs - [ ] Factions list not updated till we click on the list widget - [ ] Another xpro issue : How to reproduce ? - pasta e/ou arquivo inexiste(s) (em memor.ler) Registro acessado inexiste (xpro/jogador/xo) en memor.consultar) **** TODO May generate documentation for mods code :LOGBOOK: + CLOCK: [2021-07-07 mer. 16:02]--[2021-07-07 mer. 16:43] => 0:41 CLOCK: [2021-06-12 sam. 18:35]--[2021-06-12 sam. 18:54] => 0:19 CLOCK: [2021-06-12 sam. 18:06]--[2021-06-12 sam. 18:24] => 0:18 CLOCK: [2020-05-27 mer. 18:38]--[2020-05-27 mer. 19:00] => 0:22 @@ -273,9 +274,7 @@ mods/pathogen/gravititus/init.lua:36: attempt to index local 'digger' (a nil val CLOCK: [2020-05-07 jeu. 16:37]--[2020-05-07 jeu. 16:47] => 0:10 CLOCK: [2020-04-17 ven. 20:37]--[2020-04-17 ven. 21:00] => 0:23 :END: - *factions_ui/init.lua* is an example for documentation - - [X] =luadoc -d doc/ mods= Bad layout and doesn't show see https://keplerproject.github.io/luadoc/ @@ -292,6 +291,9 @@ mods/pathogen/gravititus/init.lua:36: attempt to index local 'digger' (a nil val - [ ] In fact, sources aren't documented, only README.md is collected Trying to document factions_ui/init.lua to see if undocumented members are in logfile + - [ ] Replace all files with Mod name + For a correctly documented mod, see mods/anvil + - [ ] md_mods_bonemeal - [ ] More hard to fix doxygen warnings diff --git a/TODO b/TODO index cab433a..33671c2 100644 --- a/TODO +++ b/TODO @@ -11,7 +11,8 @@ minetest-solebull - LGPL-2.1 - A PVP/faction game for minetest based on Cobalt. * v0.0.3-9 (27 May 2020 - ???) CLOC ???,??? -- (4) Remove a liquid_portals's empty file +- (5) Fix some mods doxygen related page +- Remove a liquid_portals's empty file - Close a 5.3.0-related ROADMAP section - Bump minor version to 3 (More than 5 ROADMAP sections) - Fix a bug when trying to disband a faction is perms array is nil diff --git a/mods/bonemeal/LICENSE.md b/mods/bonemeal/LICENSE.txt similarity index 100% rename from mods/bonemeal/LICENSE.md rename to mods/bonemeal/LICENSE.txt diff --git a/mods/bonemeal/README.md b/mods/bonemeal/README.md new file mode 100644 index 0000000..728dfce --- /dev/null +++ b/mods/bonemeal/README.md @@ -0,0 +1,12 @@ +# Bonemeal + +*Bonemeal* is crushed from bones found in dirt or by using player bones, +Mulch is made from a tree trunk surrounded by leaves and Fertiliser is a +mix of both, each of which can be used to quickly grow saplings, crops +and grass/decoration, papyrus on top of dirt and cactus on sand. Support +for ethereal saplings/crops, farming redo crops and moretrees saplings +are included. + +## Licence + +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE v2. see *Licence.txt*. diff --git a/mods/caches/README.md b/mods/caches/README.md index 31321bb..1c2a34e 100644 --- a/mods/caches/README.md +++ b/mods/caches/README.md @@ -1,3 +1,39 @@ -# caches +# Caches This is a mod for Minetest. + +## Description + +This adds portable containers that can store between 10K and 640K +items of a single type. This is similar to Thermal Expansion 4. + +There are four tiers of caches: + +Cache, Hardened Cache, Reinforced Cache, and Arcane Cache + +## How to use + +Left-click to take one stack of stored items. +Shift+Left-click to take only one item. +Right-click to store one stack of items. +Shift+Right-click to store only one item. + +Right-click with an empty hand to activate other features. + +This will present a dialog which lets you take or store everything +you can. It also lets you lock or unlock the cache, and lets you +transfer the cache (with its contents) into your inventory. You can +also set whether to output. + +## About locking + +Note that locking prevents other types of items from being stored in +the selected cache. It does not protect the cache from other players. +To protect a cache from other players, place it in a protected area. +(Area protection mod not included.) + +## Automation + +To automate using the caches, use tubes or tube-enabled machines. +Caches can be set to output through the bottom. Otherwise, they will +passively accept inputs from tubes through any side but the front. diff --git a/mods/caches/readme.txt b/mods/caches/readme.txt deleted file mode 100644 index cdbb710..0000000 --- a/mods/caches/readme.txt +++ /dev/null @@ -1,35 +0,0 @@ -Description: - -This adds portable containers that can store between 10K and 640K -items of a single type. This is similar to Thermal Expansion 4. - -There are four tiers of caches: - -Cache, Hardened Cache, Reinforced Cache, and Arcane Cache - -How to use: - -Left-click to take one stack of stored items. -Shift+Left-click to take only one item. -Right-click to store one stack of items. -Shift+Right-click to store only one item. - -Right-click with an empty hand to activate other features. - -This will present a dialog which lets you take or store everything -you can. It also lets you lock or unlock the cache, and lets you -transfer the cache (with its contents) into your inventory. You can -also set whether to output. - -About locking: - -Note that locking prevents other types of items from being stored in -the selected cache. It does not protect the cache from other players. -To protect a cache from other players, place it in a protected area. -(Area protection mod not included.) - -Automation: - -To automate using the caches, use tubes or tube-enabled machines. -Caches can be set to output through the bottom. Otherwise, they will -passively accept inputs from tubes through any side but the front. diff --git a/mods/caverealms/README.md b/mods/caverealms/README.md index 5f1f495..e5a7a66 100644 --- a/mods/caverealms/README.md +++ b/mods/caverealms/README.md @@ -1,16 +1,19 @@ -# minetest-caverealms +# caverealms A mod for Minetest to add underground realms ## Forum Topic + For more information, view the official forum topic at: - https://forum.minetest.net/viewtopic.php?f=9&t=9522 ## Contributors + - HeroOfTheWinds - everything - Zeno - additional ideas and fine tuning -##Licensing +## Licensing + - WTFPL Also be sure to check out VanessaE's texturepack "HDX", which supports this mod!