Add basic documentation

master
Wuzzy 2020-08-27 23:06:19 +02:00
parent 1cd88b8a2f
commit a94fb01568
3 changed files with 21 additions and 0 deletions

1
API.md Normal file
View File

@ -0,0 +1 @@
TO BE WRITTEN

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Calendar
This mod adds a simple and customizable calender system.
The calendar supports days, weeks, months and years.
Holidays are also supported.
By default, a year has 12 months with 30 days each, with a total of 360 days.
## Info for programmers
See `API.md`.
## Where is the date stored?
Minetest stores the number of elapsed days in the world files and it
can be queried in Lua via `minetest.get_day_count()`.
The day count is stored in the world directory under `env_meta.txt` as
`day_count`.

3
mod.conf Normal file
View File

@ -0,0 +1,3 @@
name = calendar
description = A simple calender systema calender to track the passage of days
optional_depends = default, dye