mods/orienteering/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.3
   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 * Automapper: Enables the usage of the minimap and radar (F7 key by default)
  36 * GPS device: Shows X, Y, Z coordinates, yaw and time
  37 * Quadcorder: Combination of everything above: Shows X, Y, Z coordinates, pitch,
  38   yaw, time, speed and enables minimap/radar
  39
  40 To toggle between 12h and 24h mode for the displayed time, wield any device
  41 which is capable of displaying the time and press the left mouse button.
  42
  43 ## Configuration
  44 ### Recommendations
  45 Note that in Minetest, it is also possible to access the coordinates, angles,
  46 etc. through the debug menu, but this would be generally considered cheating as
  47 this defeats the purpose of this mod. Try to resist this urge.
  48
  49 To avoid accidentally enabling debug display with a key press, you can add the
  50 following line into your `minetest.conf`:
  51
  52     keymap_toggle_debug =
  53
  54 ### HUD text position
  55 The text position can be configured by using Minetest's settings system. See
  56 the advanced settings menu for more information.
  57
  58 ## Crafting recipes
  59 Crafting recipes are only available when the default mod (from Minetest Game) is used.
  60
  61 Symbols:
  62
  63 * S = Steel Ingot
  64 * C = Copper Ingot
  65 * B = Bronze Ingot
  66 * T = Tin Ingot
  67 * G = Gold Ingot
  68 * M = Mese Crystal
  69 * D = Diamond
  70 * O = Obsidian Shard
  71 * s = Stick
  72 * g = Glass
  73 * 1 = Altimeter
  74 * 2 = Triangulator
  75 * 3 = Compass
  76 * 4 = Sextant
  77 * 5 = Watch
  78 * 6 = Speedometer
  79 * 7 = Automapper
  80 * 8 = GPS device
  81
  82 ### Altimeter
  83
  84     g
  85     C
  86     C
  87
  88 ### Triangulator
  89
  90      B
  91     B B
  92
  93 ### Compass
  94
  95      T
  96     TsT
  97      T
  98
  99 ### Sextant
 100
 101      G
 102     GGG
 103
 104 #### Watch
 105
 106     C
 107     g
 108     C
 109
 110 ### Speedometer
 111      G
 112     SsS
 113      S
 114
 115 ### Automapper
 116     GGG
 117     MOM
 118     GGG
 119
 120 ### GPS device
 121
 122     G2G
 123     3B5
 124     T1T
 125
 126 ### Quadcorder
 127
 128     GGG
 129     6D7
 130     4D8
 131
 132 ## License
 133 Everything is licensed under WTFPL.
 134