mtinfo/readme.md

48 lines
1.0 KiB
Markdown
Raw Normal View History

2019-12-09 13:59:53 +01:00
# minetest web info system
2020-02-19 20:41:38 +01:00
Project state: **WIP**
2019-12-09 13:59:53 +01:00
2020-02-20 12:18:28 +01:00
![](https://github.com/BuckarooBanzay/mtinfo/workflows/luacheck/badge.svg)
![](https://github.com/BuckarooBanzay/mtinfo/workflows/jshint/badge.svg)
2020-02-20 15:31:51 +01:00
![](https://github.com/BuckarooBanzay/mtinfo/workflows/htmllint/badge.svg)
2021-02-09 19:26:57 +01:00
![](https://github.com/BuckarooBanzay/mtinfo/workflows/generate/badge.svg)
2019-12-09 13:59:53 +01:00
2021-02-09 19:35:12 +01:00
Demo: https://buckaroobanzay.github.io/mtinfo/
2019-12-09 13:59:53 +01:00
## Overview
Generates a static info-page about the world, stats include:
* Available nodes and their properties
* Available tools
* Available items
* Recipes
* Active ABM's
* Active LBM's
2020-02-19 20:41:38 +01:00
## Usage
* Install the mod
* Start the world
* Open the generated `index.html` in the world-folder `mtinfo` with a web-browser
2021-06-02 14:25:36 +02:00
## Settings
* **mtinfo.enabled** Enables the info-page generation (default `false`)
* **mtinfo.autoshutdown** Shuts down after info-page generation (default `false`)
2021-01-16 21:06:52 +01:00
# Contributors
* https://github.com/BuckarooBanzay
* https://github.com/BobFred7
2020-02-19 20:41:38 +01:00
# License
2021-01-16 21:07:01 +01:00
MIT
2020-12-03 14:24:37 +01:00
## pics/unknown_node.png
* CC BY-SA 3.0
* https://github.com/minetest/minetest