Features

Atlas

The map app: places, routes along the roads, spoken directions, friends and timed location sharing, map signs, and Config.Atlas.

Atlas (atlas) is the map of the book. It draws its own map from bundled tiles, with no external request during play. Settings are in apps/atlas/config.lua (Config.Atlas).

#What the player can do

Map

  • Pan and zoom the map, search by name or by X, Y coordinates, and switch layers on and off.
  • Pick a place to see it, save it, or start a route.
  • Choose a travel mode (walk, horse, wagon) for the time estimate, and turn spoken directions on or off. Spoken directions are off until the player turns them on.
  • Follow the running route in the bar. The route goes on with the book closed or on another app, and clears on arrival.

My places

  • Saved places, towns and post offices, with a type filter. Save the current position, edit or delete a place.

Friends

  • Each player has an invite code. Invite a friend by code or a player standing close by, accept or refuse invites.
  • Share the position with a friend for 15 minutes, 1 hour, 8 hours or until it is turned off. Revoke a share, remove a friend.

The route line follows the roads when the road file is present. Without it the map shows the goal ring, the straight distance and the direction only.

#What it needs

Need Notes
Signal Friends: accepting and sharing need send signal, seeing friends needs receive signal. A friend is shown only while both have signal

The map, places and routes need no signal.

#Settings

Key Default What it does
Enabled true Turns the app on
MaxPins 100 Saved places per character
MaxFriends 50 Friends per character
InviteDistance 5.0 Metres for inviting a player close by
ShareSeconds { 900, 3600, 28800, 0 } Sharing time choices. 0: until revoked
PollInterval 5000 Ms between friend position updates
ArrivalDistance 15.0 Metres at which a route counts as arrived
RouteColor 'COLOR_YELLOW' Colour of the route on the game map
Navigation.Enabled true Routes and directions
Navigation.Voice true Allows spoken directions (each player turns them on)
Navigation.DefaultMode 'horse' Starting travel mode
Navigation.Speeds { walk = 2.0, horse = 6.0, wagon = 4.0 } Metres per second for time estimates
Navigation.NativeRouteDistance false Use the game GPS distance
IncludePostOffices true List the Telegraph post offices
Bounds minX = -8000, maxX = 5000, minY = -6000, maxY = 5000, minZ = -1000, maxZ = 3000 World area that places may use. Custom maps can widen it
Map bundled tiles Tile address, zoom levels (minZoom = 2, maxZoom = 5, startZoom = 4), calibration, attribution, roadsUrl
Places {} Places set by the server (see below)
Blips {} Map signs every player sees (see below)
BlipKinds store, doctor, stable, bank Names of the sign kinds
Categories place, home, work, camp, ranch, post Place types
Colors gold, red, green, blue, ink Marker colours

Map.roadsUrl = '' turns the road line off.

#Places and signs

Places are destinations you set; coordinates come from the config, never from a player.

luaPlaces = {
    { id = 'emerald', name = 'Emerald Ranch', category = 'ranch', x = 1417.8, y = 268.0, z = 89.6, bucket = 0 },
},

Signs show on the layer of shops, doctors, stables and banks when the map is zoomed in, each with a route button. On the map, places and signs are drawn as one-colour survey-map symbols by kind; towns show a church. kind is store, doctor, stable or bank; hours is free text shown on the card.

luaBlips = {
    { id = 'val_bank', name = 'Valentine Bank', kind = 'bank', hours = '08:00 - 18:00',
      x = -308.0, y = 773.8, z = 118.7, bucket = 0 },
},

A sign needs an id of letters, digits, _ or -, a name and x, y, z inside Bounds; others are skipped with a console line.

#Routes of other apps

Atlas owns the book's route on the game map. Bank branches, deeds in My Cards, town events in Calendar, Call Desk calls and the Physician's nearest doctor all draw through it. A new route replaces the old one.

apps/atlas/config_server.lua holds the app's Logs settings.