From eba41f8b7e4142150e1f4a866cb0f5e7249c55fa Mon Sep 17 00:00:00 2001 From: VanessaE Date: Wed, 6 May 2020 05:43:29 -0400 Subject: [PATCH] Added readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..982bed4 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +This mod simply looks for a file periodically, which must be created by +`touch(1)` or something similar, and owned by the same user who is +running the Minetest server. This file simply serves as a sort of flag. + +If found, the file is immediately deleted, and pop-up warnings are +issued to all players on the server that it will be rebooting soon. + +This mod must be listed in secure.trusted_mods (assuming mod security is +enabled) in order for the `os.remove()` function to work. + +The pop-up function is provided by kaeza's notice mod, from here: + +https://github.com/kaeza/minetest-kaeza_misc