ReferenceReference

Server setup

Install Orbital Atlas on a NeoForge server for team play, and set fair-play rules for radar, cave views, Seek, teleport and trains.

Players can use Orbital Atlas without installing it on the server. Installing the same jar on a NeoForge server adds team play and fair-play rules. Atlas's network channels are optional, so players without Atlas can still join, and a server with Atlas works for them as before.

Install the server add-on#

  1. Stop the server and back up the world.
  2. Put the same jar players use, orbital-atlas-neoforge-1.21.1-1.0.0-beta.1.jar, in the server's mods/ folder. Keep one Atlas jar.
  3. Start the server. Atlas creates config/orbitalatlas-server.properties and config/orbitalatlas-fairplay.properties.
  4. Check the startup log for the add-on state and fair-play summary.

The team add-on is enabled by default. Set enabled=false in orbitalatlas-server.properties and restart to disable team relaying and storage. An explicit false is preserved across updates. The JVM property -Dorbitalatlas.serverAddon=false overrides the file; =true enables it through the same override.

Fair-play rules remain available when team features are disabled. The two configuration files serve separate purposes.

Fair-play rules#

Edit config/orbitalatlas-fairplay.properties. Every feature defaults to true, meaning allowed. Set a feature to false to turn it off for Atlas clients. Changes are checked about every five seconds and sent to connected players without a restart.

KeyDefaultEffect of false
showAllUndergroundtrueDisables Show all underground. Buried ores remain hidden in every view; exposed ore can still appear. Cave maps show only caves the player has explored.
caveViewtrueDisables cave and interior cut-away views on both maps.
minimaptrueHides the HUD minimap. The full-screen world map remains available.
radarPlayerstrueHides other players from radar.
radarHostiletrueHides hostile mobs and bosses from radar and Seek.
radarPassivetrueHides passive and neutral mobs, villagers, golems, armor stands and other living entities in this class.
radarPetstrueHides tamed pets from radar and Seek.
radarBeyondRendertrueLimits radar and Seek to the player's render distance.
seektrueDisables the nearby-kind list, Seek pins, Seek this mob and last-seen pins.
teleporttrueDisables map and waypoint teleport actions for everyone subject to the rule.
trainLinestrueStops Atlas drawing the Create train network (tracks and stations).
trainstrueStops Atlas drawing Create trains on the network.
opExemptemptyComma-separated feature keys to exempt operators from, or all. Empty or none grants no exemptions.

Allowing teleport still requires normal operator permission. Seek always obeys the relevant radar-class restrictions. Allowing a feature does not provide data the client or server would otherwise lack.

Create itself sends every player the train network and the trains' positions; trainLines and trains only stop Atlas from drawing them.

For example, this keeps the world map and player radar while restricting underground information and mob finding:

showAllUnderground=false
caveView=false
radarHostile=false
radarPassive=false
radarPets=false
seek=false
opExempt=

Operator exemptions apply at permission level 2. The host of a singleplayer or LAN world is exempt from this file's rules. Atlas combines these rules with Xaero's and VoxelMap's fair-play chat codes; the more restrictive result applies.

The server log reports unknown keys and invalid values. A missing or invalid feature value allows that feature. If the file cannot be read, the last good rules remain in force; on first start, the defaults allow everything. Deleting the file recreates the defaults and allows everything again.

These rules are cooperation rules for Atlas clients. As with the fair-play chat codes, a modified client can ignore them; they keep honest players honest. Ores below the surface are never drawn as themselves unless a player turns on Show all underground, and this rule can forbid that.

The file as Atlas creates it#

When the file is missing, the server writes it with every feature allowed:

# Orbital Atlas fair play: which map features this server turns off for players.
# Atlas clients read these rules when they join and when this file changes (about every five seconds; no restart needed),
# and tell the player what is off. true = allowed (the default), false = turned off.
# They combine with Xaero's and VoxelMap's fair-play chat codes: the more restrictive of the two wins.
# A modified client can ignore these rules, as with those codes; they keep honest players honest.

# The client setting "Show all underground": ores and rare blocks below the surface drawn as themselves.
# false: buried ore stays hidden on every map view, whatever the player's setting. (Ore in an open cave or on the
# surface shows, as it does in game.) The cave view also shows only the caves each player has explored.
showAllUnderground=true
# The cave / interior cut-away view, in the minimap and the world map. false: surface only.
caveView=true
# The HUD minimap. false: it is not drawn (the full-screen world map stays).
minimap=true
# The map radar, by class. radarPlayers: other players. radarHostile: hostile mobs and bosses.
# radarPassive: passive animals, neutral mobs and other living things (villagers, golems, armor stands). radarPets: tamed pets.
radarPlayers=true
radarHostile=true
radarPassive=true
radarPets=true
# false: the radar and Seek only show creatures within the player's render distance.
radarBeyondRender=true
# Seek: the world map's list of nearby kinds, their pins, "Seek this mob" and last-seen pins. Seek never shows a class
# whose radar is off above.
seek=true
# "Teleport here" and teleporting to waypoints from the map. false: off for everyone (true still needs operator
# permission, as before).
teleport=true
# The map's Create overlays: trainLines = the train network (tracks and stations), trains = the trains on it.
# (Create itself sends every player the network and the trains' positions; false only stops Atlas drawing them.)
trainLines=true
trains=true

# Operators (permission level 2) can be exempt from rules above: a comma list of the keys (for example:
# opExempt=showAllUnderground,seek), or all. Empty: no exemption. (The host of a singleplayer or LAN world is never
# held to these rules.)
opExempt=

Team features and limits#

Edit config/orbitalatlas-server.properties, then restart. Numeric limits are clamped to their supported ranges.

KeyDefaultPurpose
enabledtrueEnables the team add-on.
pingstrueRelays short-lived teammate pings.
markstrueRelays team marks.
marksPerPlayer10Maximum active marks per player.
routestrueAllows published team routes.
routesPerPlayer8Maximum routes published by a player.
routesPerTeam64Maximum published routes per team.
routePoints2048Maximum points per published route.
roadstruePermits shared team roads; player opt-in and the team's roads switch are also required.
teamRoadsDefaultfalseInitial roads switch for a new team.
roadEdgesPerTeam32768Maximum stored road steps per team.
roadFadeDays30Unused road steps fade after this many days.
teams256Maximum teams with stored data.
namestrueAllows region names shared with a team.
namesPerPlayer64Maximum shared names per player.
namesPerTeam1024Maximum shared names per team.
serverNamesfalseAllows operators to share region names with every Atlas player.
serverNamesMax1024Maximum server-wide region names.
positionstrueSends far teammates' positions in the same dimension, about four times a second.
positionsScoreboardtrueIncludes vanilla scoreboard teams in far teammate positions; false limits them to FTB Teams parties.
metricsFileemptyOptional Prometheus text-file path ending in .prom, relative to the server directory.

Atlas uses FTB Teams parties when available, otherwise vanilla scoreboard teams. A player in neither has a personal team. Party owners and officers administer team roads and routes; operators administer scoreboard teams. Team data is sent to teammates. Operator-published server names are the explicit server-wide exception.

Far teammate positions respect the server's player visibility rules. No position history is saved by this feature. Players can disable use of the team add-on in their own settings; fair-play rules still apply.

Stored data and backups#

LocationContentsLifetime
<world>/data/orbitalatlas-team.datPublished routes, their publisher's UUID and name, route points and times; shared road steps and the team roads switchRoutes until unpublished; roads fade after roadFadeDays.
<world>/data/orbitalatlas-names.datShared region names, anchors, biome, dimension, author's UUID and name, and sharing timeUntil cleared by the author or an administrator.
MemoryPings, marks and current far teammate positionsPings and marks expire or disappear on restart; positions are live data.

Changed stores are saved every five minutes and when the server stops. Include them in normal world backups. Published routes disclose when players visited each point; tell players before enabling team sharing.

Disabling a feature stops its use and leaves existing stored files on disk. To remove all stored Atlas team data, stop the server, retain a backup, then remove the two store files. Backups can still contain the earlier data.

Store failures and mixed versions#

A store from a newer Atlas version is left untouched, with its features disabled until the server is updated. A file that cannot be decoded is moved to a timestamped .bad-… copy before Atlas starts an empty store. An unreadable, oversized or unsuitable file that cannot be moved is left in place and its features stay off for that run. Check the warning and preserve the original before restoring a backup with the server stopped.

Different client builds negotiate a supported team protocol. If none overlaps, team features remain off for that player; the client map can still work. Keep server and client builds aligned when updating stored features.

Monitoring#

The add-on logs a counts-only status line every fifteen minutes. A configured metricsFile is replaced atomically about once a minute while the add-on is on. It contains player, team and feature counts and dropped-message counters, without player or place names. An invalid extension disables the metrics file and logs a warning.

If a team feature fails, a warning names it and disables it until restart; other team features continue. Fair-play load and reload warnings are reported separately.

Search settings, controls and guides. Use Tab to move through results.