summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 12 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..143c47c
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+Day/Night Mode Selector for Minetest
+====================================
+
+This is a mod for Minetest that adds a simple way to select "automatic" (normal) day/night cycling, always day, or always night. It works per-player, and settings are persistent across restarts.
+
+Usage (inventory button): Press the button in the inventory to open the menu, then select the desired mode. Use "automatic" to return to normal behavior.
+
+Usage (chat command): Use the /dayratio command by itself to open the menu, or specify a number from 0 to 1 after it to set a custom value. Custom values set the ratio between day and night - for example, a value of 0.25 will set your lighting to be 1/4 day and 3/4 night. The light level is then unaffected by the time of day. Use a value of "nil" to return to normal behavior.
+
+Dependencies: unified_inventory
+
+License: Unlicense, see the "LICENSE" file for full license text.