Add README.md

This commit is contained in:
Signal 2025-10-02 21:57:48 +00:00
parent 200e3f7642
commit e39a24711a

17
README.md Normal file
View file

@ -0,0 +1,17 @@
A new main menu for Minetest, rewritten completely from scratch.
Features so far:
* An art style.
* More intuitive layout.
* The Lua API documentation is embedded in the About tab.
* The Lua API documentation gets syntax highlighting.
* A full dynamic templating engine that allows games to customize their corner of the main menu in almost any way imaginable.
To try this main menu, clone this repository and modify the paths in `local assets` and `function include` to properly reflect the location you cloned into. Then, set the main_menu_script setting in Minetest to point to `init.lua` and restart Minetest.
# Screenshots
<div align="center">
<img src="screenshots/meta.png" width="50%">
</div>