Features
Compass
The live pocket compass: heading from the camera or the body, towns on the dial with distance and side, the built-in guide, and Config.Pusula.
Compass (pusula) is a live brass pocket compass. It shows the way the player faces in degrees and by name, for example "Northwest · 312°". A picked town gets a marker on the dial with its distance and the side it lies on. It comes installed on new characters. Settings are in apps/pusula/config.lua (Config.Pusula).
#What the player can do
- Read the heading: the card turns, the red mark at the top is where the player faces, and the line under the dial gives the direction name and degrees. North is 0, counted clockwise. The direction letters sit at the tips of the rose, in the player's language.
- Tap a town in the list. A diamond marks it on the dial, and the page writes its distance and whether it is ahead, on the right, behind or on the left. Near a town the page reads "You are here".
- Open the guide with the "i" button: what a compass is, the eight directions, reading this dial, finding a town, and real-life tips. The guide opens by itself the first time a character opens the compass.
The picked town stays picked for the session, also when the page is closed and opened again.
#How the heading is read
The heading comes from the player's own game. Nothing is sent to the server.
Heading = 'camera': the way the player looks, as the game's own minimap turns. While the cursor is on the book the card stays still; it follows the view when the player walks or rides.Heading = 'body': the way the character's body faces.
The reading runs only while the compass page is open and the book is out: about ten readings a second, and the page is updated only when the heading turned by a degree or the player moved 10 metres. Closing the page or the book stops it.
#What it needs
Nothing. No signal, money, items or server requests.
#Settings
| Key | Default | What it does |
|---|---|---|
Enabled |
true |
Turns the app on. false: the page says the compass is off |
Heading |
'camera' |
'camera': where the player looks. 'body': where the character faces |
Towns |
nil |
Towns on the dial. nil uses the bank's town list (Config.Bank.CashInTown.Towns) |
TownRadius |
220 |
Metres: nearer than this to a town (or its own radius) reads "You are here" |
With Towns = nil the dial lists the nine towns of the Bank app: Valentine, Rhodes, Saint Denis, Blackwater, Armadillo, Strawberry, Annesburg, Van Horn and Tumbleweed.
Your own towns:
luaConfig.Pusula = {
Enabled = true,
Heading = 'body',
Towns = {
{ town = 'Valentine', coords = vector3(-308.0, 773.8, 118.7), radius = 220 },
{ town = 'Saint Denis', coords = vector3(2644.1, -1292.2, 52.2), radius = 480 },
{ town = 'Emerald Ranch', coords = vector3(1417.8, 268.0, 89.6) },
},
TownRadius = 220,
}
A town needs town (the name shown) and coords. radius is optional.