code/modules/overmap/README.md 
/* The overmap system allows adding new maps to the big 'galaxy' map. There's overmap zlevel, that looks like a map. On it, token objects (overmap objects) are moved, representing ship movement etc. No actual turfs are moved, you would need exploration shuttles or teleports to move atoms between different sectors/ships. Unless stated otherwise, you just need to place any of things below somewhere on the map and they'll handle the rest. How to make new sector
How to make new ship
Overmap object/obj/effect/overmap WHAT IT DOESLets overmap know this place should be represented on the map as a sector/ship. If this zlevel (or any of connected ones for multiz) doesn't have this object, you won't be able to travel there by ovemap means. HOW TO USE
If it's player's main base (e.g Exodus), set 'base' var to 1, so it adds itself to station_levels list. If this place cannot be reached or left with EVA, set 'in_space' var to 0 If you want exploration shuttles (look below) to be able to dock here, set up waypoints lists. generic_waypoints is list of landmark_tags of waypoints any shttle should be able to visit. restricted_waypoints is list of 'shuttle name = list(landmark_tags)' pairs for waypoints only those shuttles can visit Helm console/obj/machinery/computer/helm WHAT IT DOESLets you steer ship around on overmap. Lets you use autopilot. HOW TO USEJust place it anywhere on the ship. Engines control console/obj/machinery/computer/engines WHAT IT DOESLets use set thrust limits for engines of your ship. Lets you shutdown/restart the engines. Lets you check status of engines. HOW TO USEJust place it anywhere on the ship. Thermal engines/obj/machinery/atmospherics/unary/engine WHAT IT DOESLets your ship move on the map at all. HOW TO USEPut them on map, hook up to pipes with any gas. Heavier gas (CO2/plasma) + More pressure = more thrust. Exploration shuttle terminal/obj/machinery/computer/shuttle_control/explore WHAT IT DOESLets you control shuttles that can change destinations and visit other sectors/ships. HOW TO USE
|