README.md

   1 # Calendar
   2
   3 This mod adds a simple and customizable calender system.
   4
   5 The calendar supports days, weeks, months and years.
   6 Holidays are also supported.
   7
   8 To make things simpler, all months have the same length.
   9
  10 By default, a year has 12 months (January to December) with 30 days each.
  11 There are 7 weekdays from Monday to Sunday, starting at Monday.
  12 The calendar starts at Day 1, Month 1 (January), Year 1.
  13
  14 ## Version
  15 1.1.1
  16
  17 ## Compability
  18 This mod is designed for Minetest 5.3.0, but there's a compability
  19 mode for version 0.4.17.
  20
  21 Due to a limited feature set, the calender form looks a bit differently
  22 in 0.4.17. Fake buttons are used for the day boxes to allow the use of
  23 tooltips.
  24
  25 ## Customizing the calendar
  26 If you want to customize the calendar (e.g. change the length of months),
  27 read the text file `API.md`.
  28
  29 ## Info for programmers
  30 See `API.md`.
  31
  32 ## Where is the date stored?
  33 Minetest stores the number of elapsed days in the world files and it
  34 can be queried in Lua via `minetest.get_day_count()`.
  35 The day count is stored in the world directory under `env_meta.txt` as
  36 `day_count`.
  37
  38 ## License
  39 This entire mod is licensed under the
  40 GNU Lesser General Public License version 3 (LGPL-3.0).
  41
  42 This mod was created by Wuzzy. A small portion of the mod was adopted
  43 from the [belfry] mod by sorcerykid, namely `calendar.get_date_string`,
  44 based on `minetest.get_date_string` from the `belfry` mod.