# Atlascraft World map, minimap, compass, waypoints, pings and fog of war for Unreal Engine. One plugin, no dependencies, baked straight from your level (World Partition included), replicated for multiplayer and fully usable from Blueprint. ## The example level Open **`/Atlascraft/Demo/L_ATDemo`** (in the Content Browser, Settings > Show Plugin Content) and press Play. It has every piece working together: - the ready HUD: minimap, compass, icons over the world, world map with its legend (M or the gamepad's Start); - markers of three categories (Quests, Services, Landmarks) with the example icons in `/Atlascraft/Icons`; the lake only shows once you find it, and the far quest sticks to the edge of the minimap; - fog of war, cleared by your pawn and by a watchtower that reveals for every player; - a patrol walking a circle, its icon turning with it; - a hall of two floors, each with its own map (stand inside, or pick the floor on the world map); - three named zones (the town, the lake, the hall's grounds) drawn on the world map, with the name on screen as you walk in; - waypoints and pings (click the world map, or the middle mouse button), with the route to the waypoint drawn on the maps over a navmesh built at runtime around the start; - fast travel to the town and the hall once you have found them (click their icon on the world map), and notes you write on the map (Shift + click); - F5 / F9 to save and load the fog, the waypoint and the notes through `UATSaveGame`. Press **Tab** (gamepad Back) to switch to **`L_ATVision`**, the vision fog demo: walls and a tall block, four enemies walking behind them, and your 30 m of sight cut by the walls. You walk the demo on foot (WASD, mouse, Space to jump), like the Third Person template; **F** flies, with E and Q for up and down, to cross the map fast. The hall has a door downstairs and a ramp outside up to a door on the upper floor, to see the map switch floors as you walk in. The pawn is the template's mannequin when the project has `/Game/Characters/Mannequins` (any project made from the Third Person template, and the demo project), and a plain cylinder otherwise. The mannequin is Epic Games content and is not part of the plugin. The controls are written in a corner of the screen. The demo's keys are Enhanced Input assets you can remap: `IMC_ATDemo` and the `IA_AT*` actions in `/Atlascraft/Input` (a project still on the old input gets the same keys bound directly). The demo classes (`AATDemoGameMode`, `AATDemoPlayerController`, `AATDemoPawn`, `AATDemoWatchtower`, `AATDemoPatrol`) are short and meant to be read and copied. ## A minimap in 2 minutes, no Blueprint nodes 1. **Place an `AT Map Volume`** over the playable area and press **Bake Map** on it. 2. **Add the `AT Player Setup` component to your player controller** (the Third Person template's `BP_ThirdPersonPlayerController`, or any other). Play. The component does the rest: on the server it gives the player state a Waypoint and a Fog component, the controller a Route and every pawn it possesses a Revealer; on the player's screen it shows `WBP_ATHUD` and binds the keys (M or the gamepad's Start opens the map, the middle mouse button or d-pad up pings). Each piece has a tick box to leave it out, and anything you already added yourself is kept as it is. The keys are in `IMC_ATMap` (`/Atlascraft/Input`), ready to remap. To see it without touching your project, open any level, pick **`BP_ATExampleGameMode`** (`/Atlascraft/Examples`) as GameMode Override in World Settings and press Play. **`BP_ATExampleMarker`** is a marker you can drop anywhere, and **`BP_ATExampleWidgetMarker`** one drawn as a widget. ## The same setup by hand For a project that wants every piece where it chooses: 1. **Place an `AT Map Volume`** over the playable area and size its box to cover it. North on the map is +X in the world, east is +Y, the same as the editor's top view. 2. **Press Bake Map** on the volume. The level is photographed from above and saved as a texture and a Map Data asset (`T_<Level>_Map`, `DA_<Level>_Map`, in `/Game/Atlascraft` unless you set Output Folder). With World Partition each tile loads its own cells, so the map can be bigger than what fits in memory. 2 km at 2048 px takes about 2 seconds. 3. **Show the HUD.** Create `WBP_ATHUD` (in `/Atlascraft/UI`) from your player controller or HUD and add it to the viewport. It holds the minimap, the compass, the icons over the world and the world map with its legend. 4. **Give your Player State a `Waypoint` component** for waypoints and pings, and a `Fog` component if you want fog of war. Give the pawn a `Revealer` component to clear the fog around it. The templates have no Player State of their own: make a Blueprint child of Player State, add the components, and set it as Player State Class on your Game Mode. 5. **Add a `Route` component to the player controller** for the way to the waypoint. 6. **Bind a key to Toggle World Map** on the HUD (the demo controller uses M and the gamepad's menu button). Everything below is optional. ## What shows on the maps Anything with an **`AT Marker`** component shows on the minimap, the world map, the compass and, if you want, over the world on screen. Nothing extra is replicated: a marker lives on every machine with its actor. For a spot with no actor of its own (a town, a quest area, a shop door), drop an **`AT Marker Actor`** in the level and set up its Marker component. With World Partition it is always loaded, so it shows on the maps from anywhere. Give anything else that carries a marker the same setting (Is Spatially Loaded off), or it vanishes from the maps while its cell is unloaded. | Setting | What it does | |---|---| | Icon, Color, Icon Size | The look. No icon draws a dot in the colour. | | Label | Name on the world map. | | Category | For the legend and the filters: a whole category can be hidden at once. | | Show On Minimap / World Map / Compass | Where it shows. | | Show In World | An icon floats over it on screen, with the distance. | | Stick To Minimap Edge | Out of the minimap's range it stays on the edge, pointing the way (quest targets, teammates). | | Show Distance On Compass | Writes the distance next to it on the compass. | | Rotate With Actor | The icon turns with its actor (vehicles, other players). | | Hidden Under Fog | Hidden while its spot is under the local player's fog. | | Fast Travel Point | Players can travel here from the world map, once they have found it (Fast Travel Needs Discovery). | ## Widgets All of them are in the UMG palette under **Atlascraft**, so you can build your own HUD instead of `WBP_ATHUD`. - **AT Map View**: the minimap and the world map. Round or square, turning with the camera or north up, following the player or placed by hand. With **Interactive** on, dragging moves it, the wheel zooms, a left click sets the waypoint (click it again to clear it) and a right click pings. **On Map Clicked** gives you the world spot for anything else. **Click At** does what a click does, for gamepad cursors. - **AT Compass**: a strip with the eight directions (rename them in Direction Names) and every marker at its bearing. - **AT World Markers**: stretch it over the whole screen. Icons over the world, the distance under each, and out of view they slide to the screen edge. - **AT Map Legend**: one row per marker category in the world. Clicking a row hides or shows that category everywhere. `WBP_ATHUD` keeps working if you redesign it, as long as the widgets keep their names: `Minimap`, `Compass`, `WorldMarkers`, `WorldMap` and `Legend`. With an empty designer it builds the default layout itself. Widgets you draw keep the settings you give them (round or square, zoom, Interactive and the rest); only the ones the HUD builds get its defaults. ### Changing the look - **Colours and font** for the whole HUD: a **Style** data asset (`DA_ATStyle_Dark`, `DA_ATStyle_Parchment` in `/Atlascraft/UI/Styles`). Make a copy, set it on `WBP_ATHUD`, or call **Apply Style** in game. - **Images**: the style (or each widget) takes a **Minimap Mask** (any shape: its alpha cuts the map), a **Minimap Frame** drawn over it, and a **Background Brush** for the compass and the legend. **Player Icon** replaces the arrow. - **Label Font** on a map view sets the labels, zone names and floor name. - **Distance Units** on the compass and the screen icons (or the style): metres and kilometres, or feet and miles. The words go through the `Atlascraft` localization namespace. - **Map Material** on a map view swaps the whole map picture for your own material (start from a copy of `M_ATMapView`). - 37 white icons in `/Atlascraft/Icons` and `/Atlascraft/Icons/Pack` (enemy, boss, chest, door, key, camp, shop, smith, healer, portal, dungeon and more). White, so the marker's Color tints them. - **A widget per marker**: set **Widget Class** on the Marker component to a Widget Blueprint whose parent is **AT Marker Widget**, and that widget is drawn instead of the icon on the minimap, the world map and the screen. Name an Image `MarkerIcon` and Text blocks `MarkerLabel` and `MarkerDistance` and they fill themselves from the marker; anything else in the widget is yours (a progress bar, an animation, a frame). The widget reads **Place** (Minimap, World Map or Screen), **Distance Cm**, **Distance Text**, **On Edge** and **Edge Angle** (to turn an arrow when it sits on the edge), and gets **On Marker Set** once. With an empty designer it builds icon, name and distance itself: `WBP_ATExampleMarkerWidget` in `/Atlascraft/Examples` starts that way. **Get Marker Widget** on a map view or on World Markers returns the widget drawn for a marker. Clicks and hover on the world map work the same as on an icon. **Events for your own UI:** On Map Clicked, On Marker Hovered (a tooltip; call **Hover At** for a gamepad cursor), On Fast Travel Clicked and On Note Requested on the map view; On World Map Toggled, On Zone Entered and On Region Entered (a floor or a cave) on the HUD; On Ping Shown and On Fast Travel on the Waypoint component; On Fog Changed on the Fog; On Seen Changed on each Vision component. **Gamepad on the open world map:** left stick moves, triggers zoom, the bottom face button sets the waypoint and the left one pings at the crosshair in the middle, the d-pad picks a legend row and the top face button toggles it, the shoulders change the floor shown, the right stick press writes a note. **Touch on the world map:** one finger drags, two fingers pinch to zoom, a tap clicks (waypoint, fast travel) and a long press pings (**Long Press Seconds**). The same gestures go through **Touch Started / Moved / Ended** if you route touch yourself. ## Waypoints and pings The **Waypoint** component goes on the Player State. Call **Set Waypoint**, **Clear Waypoint**, **Ping** or **Ping Where Looking** from the owning player (UI, input); the server keeps them and every machine shows them on the maps, the compass and the screen. - The waypoint shows to its owner, and to the team with **Share Waypoint With Team**. It clears itself when the pawn gets within **Arrival Radius**. - Pings show to everyone on the same **Team**. They last **Ping Seconds**, each player has at most **Max Pings**, and **Ping Cooldown Seconds** stops spam. **Ping Styles** sets their looks ("go here", "enemy", "loot"), **On Ping Shown** is where you play a sound. - A click on the map finds the ground's height when that part of the level is loaded on the clicking machine; otherwise the spot goes out at height 0 and each machine finds the ground once it loads there. ## Route Add a **Route** component to your player controller and the maps draw the way to the waypoint: a path on the navmesh, found off the game thread and asked again as the pawn moves. The compass and the icons over the world then give the waypoint's distance along the route. **Set Target** routes somewhere else (a quest goal) until **Clear Target**. - It needs a navmesh where the player walks. Past its edge, or where the level is not loaded, the route goes as far as the navmesh does and straight from there; with no navmesh at all it is a straight line (Straight Line Without NavMesh). - On a network client the engine has no navmesh by default, so the client asks the server for the path and draws what comes back (**Ask Server For Path**, on by default): a few hundred bytes every half second while the player moves. With **Allow Client Side Navigation** on in the project, the client finds it itself. - Colour and width are on the component. ## Fast travel and notes - Tick **Fast Travel Point** on a marker. A left click on its icon on the world map travels there, once the player has found it (its spot is out of their fog). The server checks again and moves the pawn; turn off **Fast Travel Teleports Pawn** to do it yourself from **On Fast Travel** (a loading screen, a fade). Turn off **Click Fast Travels** on the map view to show your own confirmation from **On Fast Travel Clicked**. - With World Partition the destination may not be loaded when the player lands there. A Character that was walking is held in the air until its ground loads, then put on it (**Hold Character Until Ground Loads**, at most **Ground Hold Max Seconds**), so it does not fall through the world. - **Shift + click** on the world map (or the gamepad's right stick press) opens a box to write a note there; Enter keeps it. Shift + click on a note removes it. Notes live on the Waypoint component (**Add Note**, **Remove Note Near**, **Get Notes**), are the player's own unless **Share Notes With Team**, and go into `UATSaveGame`. - The world map writes each marker's **Label** under its icon (**Show Labels** on the map view). ## Fog of war The **Fog** component goes on the Player State; a **Revealer** component on the pawn (or a watchtower, a scout) clears it. On an actor that is not a player's pawn, set its **Team**, or tick **Reveal For Everyone** for a place every player knows. - The level is cut into cells of **Cell Size** (10 m by default). The server reveals cells; only the owning player receives their own fog, and only the blocks of 16 x 16 cells that changed. - Players with the same **Team** (0 or more) share what any of them sees. Change teams in game with **Set Team**: it also shares what each player had seen before. A Team set in the details panel does the same when the game starts. - A watchtower or any revealer that never moves still reveals for players who join or change team later. - A new map for the level (**Set Map Data** in game) starts every player's fog over on the new grid. - The fog picture is one texture: keep it under 8192 cells a side (82 km at the default 10 m cells; raise Cell Size past that). - **Reveal From** merges another player's fog into this one (sharing a map with a friend). - **Save Revealed** and **Load Revealed** pack the fog into bytes for your save. `UATSaveGame` is a ready example with the waypoint and the notes too: **Save To Slot** and **Load From Slot** on the server. - Markers can hide under the fog (Hidden Under Fog), and the map widgets darken what is still hidden (Fog Color; its alpha is how much of the map shows through). Measured on a 2 km map with two clients: revealing costs 0.001 ms, a trail across the whole map saves in 520 bytes, and each client received 1.3 to 1.7 KB/s in total, everything the server sent included. ## Vision fog (RTS, MOBA, tactics) The fog of war above remembers where a player has been. Vision fog is what the team sees **now**: it follows the units, walls and hills block it, and enemies outside it disappear. - Put an **AT Vision** component on every unit, hero, tower and enemy, with its **Team**, **Sight Radius** and **Eye Height**. The local player's own pawn sees for them whatever its team. - Line of sight reads the **heights** Bake Map saves (on by default: **Bake Heights**, **Heights Resolution**): the highest thing at each spot seen from above, so walls, hills, roofs and trees block the view. Pawns and anything with a Vision component stay out of the bake. Without heights, or with **Blocked By Heights** off, a unit sees a full circle. - Enemies with **Hide When Not Seen** are hidden on screen while no one on the local team sees them (their components only: nothing is changed on the actor that would replicate). Give their markers **Hidden Outside Vision** to take them off the maps, the compass and the screen icons too. - The maps darken what is not seen now (**Not Seen Darkness** on the map volume). With **World Vision Fog** on, a post process on each player's machine darkens the world the same way, and never-explored ground more (**Unexplored Darkness**, when the player has a Fog component). - The grid's cell is **Vision Cell Size** on the map volume (4 m by default; the vision demo uses 1 m). It is redone ten times a second. - Nothing extra replicates: each machine works out its own team's sight from the units it already receives. That also means a cheating client could see more: keep what matters (damage, targeting, what the server sends) on the server. - Blueprint: **Is Visible** and **Get Local Team** on the Vision subsystem, **Is Seen Locally** on the component. ## Zones An **`AT Map Zone`** is a named area: a town, a forest, an enemy camp. Size and turn its box like any actor. - The world map fills it with its **Color**, draws the outline and writes the name along its top. **Show On Minimap** adds the outline to the minimap too. - The ready HUD writes the name under the compass when the player walks in (**Announce On Enter**, **Zone Banner Seconds**); **On Zone Entered** on the HUD is there for music or a quest. - **Hidden Until Found** keeps it off the maps while its middle is under the player's fog, so "found" is saved with the fog. **Priority** settles overlaps (the smallest wins a tie); **Ignore Height** makes it a flat area, off for a room. - Always loaded with World Partition. Nothing replicates. ## Buildings, floors and caves An **`AT Map Region`** is a part of the level with its own map. Size its box from the floor to just under the ceiling and press Bake Map on it: the camera starts at the top of the box, so the roof and the floors above are left out. Give each region a **Map Name** so the baked assets do not overwrite each other. While the player is inside, the map widgets draw the region's map over the level's, in the same place. Where regions overlap, the highest **Priority** wins. On the world map, **Shown Region** picks a floor whatever floor the player is on (the HUD cycles them with the gamepad shoulders); **Display Name** is what the map shows while one is picked. ## The baked look - **Base Color** (default): surface colours only, no light or shadow. Flat, easy to read, the same every time. - **Lit**: the level's own light and shadows, exposed once for the whole map so the tiles match. **Lit Exposure Bias** makes it brighter or darker in stops, **Lit Shadow Fill** sets how much of the surface colour shows where no light reaches. Very long shadows (from things hundreds of metres tall) can be cut at a tile's edge; raising the sun's Dynamic Shadow Distance helps. ### Big worlds: detail tiles One picture covers the whole map: 2048 px over 2 km is a metre per pixel, but over 8 km it is four. Tick **Bake Detail Tiles** on the volume and the bake also saves one sharper picture per tile (**Detail Tile Pixels**, 1024 by default: half a metre per pixel on a 512 m tile). The map views load only the tiles under the view, in the background, and only once zoomed in past the main picture's pixels; zoomed out they let them go. Each view draws them into one 2048 px picture (16 MB) and holds at most 4 x 4 tiles. **Use Detail Tiles** on a view turns it off. The demo level bakes them. If something covers the level from above in the picture (an old mesh sky sphere, a cloud layer made of meshes), add it to the volume's **Hidden Actors**. Or skip the bake: make a Map Data asset by hand with your own picture and the square of the world it covers, and set it on the volume. ## Split screen Each HUD follows its own player: the minimap, the floor shown, the zone's name and each player's own waypoint. Vision fog and the world fog post process follow the first player of the machine. ## Multiplayer summary | Thing | Where it runs | What goes over the network | |---|---|---| | Map, markers, widgets | Every machine | Nothing | | Fog | Server reveals | Changed 32-byte blocks, to the owner only | | Waypoint, pings | Server keeps | A few bytes per change, to everyone; each machine decides what it shows (a cheating client can read the other team's pings) | | Route | Client, or server for a network client | The path's corners, to its player only | | Teams | Server sets | The team number | ## Supported versions Unreal Engine 5.6, 5.7 and 5.8, Windows.