README.md

   1 # Orienteering
   2 This mod adds several tools which mostly aid in orientation. When carrying them,
   3 this will enhance the HUD by adding several interesting information such as the
   4 coordinates or the viewing angles or enabling the use of the minimap.
   5
   6 Current version: 1.4
   7
   8 ## Mod support
   9 All dependencies are optional.
  10
  11 There is an optional dependency on default from Minetest Game.
  12 It enables the use of crafting recipes.
  13
  14 There is an optional dependency on Achievements [`awards`] by rubenwardy. If
  15 both this mod and the default mod are enabled, the achievement “Master of
  16 Orienteering” will be added.
  17
  18 This mod includes item help texts for `doc_items` of the Documentation System
  19 modpack.
  20
  21 ## Tools
  22 The orienteering tools are used automatically. To use them, you only need to
  23 have them somewhere in your hotbar. Most tools add information at the top
  24 section of your screen. The minimap is disabled by default, in this mod
  25 you have to acquire the proper tool first.
  26
  27 The following tools are available:
  28
  29 * Altimeter: Shows height (Y)
  30 * Triangulator: Shows X and Z coordinates
  31 * Compass: Shows yaw (horizontal angle)
  32 * Sextant: Shows pitch (vertical angle)
  33 * Watch: Shows the time (hours and minutes)
  34 * Speedometer: Shows speed in m/s (1 m = side length of a single cube)
  35 * Map: Enables usage of the minimap (F7 key by default) (only surface mode)
  36 * Radar Mapper: Enables the usage of the minimap (surface and radar mode)
  37 * GPS device: Shows X, Y, Z coordinates, yaw and time
  38 * Quadcorder: Combination of everything above: Shows X, Y, Z coordinates, pitch,
  39   yaw, time, speed and enables minimap/radar
  40
  41 To toggle between 12h and 24h mode for the displayed time, wield any device
  42 which is capable of displaying the time and press the left mouse button.
  43
  44 ## Configuration
  45 ### Recommendations
  46 Note that in Minetest, it is also possible to access the coordinates, angles,
  47 etc. through the debug menu, but this would be generally considered cheating as
  48 this defeats the purpose of this mod. Try to resist this urge.
  49
  50 To avoid accidentally enabling debug display with a key press, you can add the
  51 following line into your `minetest.conf`:
  52
  53     keymap_toggle_debug =
  54
  55 ### HUD text position
  56 The text position can be configured by using Minetest's settings system. See
  57 the advanced settings menu for more information.
  58
  59 ## Crafting recipes
  60 Crafting recipes are only available when the default mod (from Minetest Game) is used.
  61
  62 Use a crafting guide to see crafting recipes.
  63
  64 ## License
  65 Everything is licensed under MIT License.
  66