mirror of
https://repo.or.cz/minetest_orienteering.git
synced 2024-08-20 04:34:07 +02:00
Add README.md
This commit is contained in:
parent
3a9c36634b
commit
c335bc7042
120
README.md
Normal file
120
README.md
Normal file
@ -0,0 +1,120 @@
|
||||
# Orienteering
|
||||
This mod adds several tools which mostly aid in orientation. When carrying them,
|
||||
this will enhance the HUD by adding several interesting information such as the
|
||||
coordinates or the viewing angles or enabling the use of the minimap.
|
||||
|
||||
Current version: 0.1
|
||||
|
||||
## Dependencies
|
||||
There is an optional dependency on default from Minetest Game.
|
||||
It enables the use of crafting recipes.
|
||||
|
||||
## Tools
|
||||
The orienteering tools are used automatically. To use them, you only need to
|
||||
have them somewhere in your main player inventory. Most tools add information
|
||||
at the top section of your screen. The minimap is disabled by default, in this
|
||||
mod you have to acquire the proper tool first.
|
||||
|
||||
The following tools are available:
|
||||
|
||||
* Altimeter: Shows height (Y)
|
||||
* Triangulator: Shows X and Z coordinates
|
||||
* Compass: Shows yaw (horizontal angle)
|
||||
* Sextant: Shows pitch (vertical angle)
|
||||
* Watch: Shows the time (hours and minutes). Leftclick to toggle between 12h
|
||||
and 24h mode
|
||||
* Speedometer: Shows speed in m/s (1 m = side length of a single cube)
|
||||
* Automapper: Enables the usage of the minimap and radar (F7 key by default)
|
||||
* GPS device: Shows X, Y, Z coordinates, yaw and time
|
||||
* Quadcorder: Ultimate tool: Shows X, Y, Z coordinates, pitch, yaw, time, speed
|
||||
and enables minimap/radar
|
||||
|
||||
## Configuration recommendations
|
||||
Note that in Minetest, it is also possible to access the coordinates, angles,
|
||||
etc. through the debug menu, but this would be generally considered cheating as
|
||||
this defeats the purpose of this mod. Try to resist this urge.
|
||||
|
||||
To avoid accidentally enabling debug display with a keypress, you can add the
|
||||
following line into your `minetest.conf`:
|
||||
|
||||
keymap_toggle_debug =
|
||||
|
||||
|
||||
## Crafting recipes
|
||||
Crafting recipes are only available when the default mod is used.
|
||||
|
||||
Legend:
|
||||
|
||||
* S = Steel ingot
|
||||
* C = Copper ingot
|
||||
* B = Bronze ingot
|
||||
* G = Gold ingot
|
||||
* M = Mese crystal
|
||||
* D = Diamond
|
||||
* s = Stick
|
||||
* g = Glass
|
||||
* 1 = Altimeter
|
||||
* 2 = Triangulator
|
||||
* 3 = Compass
|
||||
* 4 = Sextant
|
||||
* 5 = Watch
|
||||
* 6 = Speedometer
|
||||
* 7 = Automapper
|
||||
* 8 = GPS device
|
||||
|
||||
### Altimeter
|
||||
|
||||
C
|
||||
C
|
||||
C
|
||||
|
||||
### Triangulator
|
||||
|
||||
B
|
||||
B B
|
||||
|
||||
### Compass
|
||||
|
||||
C
|
||||
CsC
|
||||
C
|
||||
|
||||
### Sextant
|
||||
|
||||
G
|
||||
GGG
|
||||
|
||||
#### Watch
|
||||
|
||||
C
|
||||
g
|
||||
C
|
||||
|
||||
### Speedometer
|
||||
S
|
||||
SsS
|
||||
S
|
||||
|
||||
### Automapper
|
||||
GGG
|
||||
MOM
|
||||
GGG
|
||||
|
||||
### GPS device
|
||||
|
||||
G2G
|
||||
3B5
|
||||
S1S
|
||||
|
||||
### Quadcorder
|
||||
|
||||
GGG
|
||||
6D7
|
||||
4D8
|
||||
|
||||
|
||||
|
||||
|
||||
## License
|
||||
Everything is licensed under WTFPL.
|
||||
|
Loading…
Reference in New Issue
Block a user