# {icon:help} Basics
§fWayfarer's Map§r draws everything you have §aalready seen§r. New places appear on the map as you explore.

- §e{key:open_map}§r — open / close the world map
- §e{key:toggle_minimap}§r — show / hide the minimap
- §e{key:new_waypoint}§r — new waypoint where you stand

> Every key, and how to change them — the §bKeys§r section.

# {icon:keys} Keys
All keys of the mod are set in Minecraft's §bOptions → Controls§r (category §fWayfarer's Map§r); this list shows them as they are set now.

- §e{key:open_map}§r — open / close the world map
- §e{key:toggle_minimap}§r — show / hide the minimap
- §e{key:zoom_in}§r / §e{key:zoom_out}§r — minimap zoom in / out
- §e{key:new_waypoint}§r — new waypoint where you stand
- §e{key:waypoint_list}§r — waypoint list
- §e{key:cave_mode}§r — cave mode (auto / off / on)

§fWithout a key at first§r (set one to switch these without opening the map; works for the minimap too):
- §e{key:mode_blocks}§r — 2D map, §e{key:mode_plantless}§r — 2D map without plants
- §e{key:mode_topo}§r — topography, §e{key:mode_biomes}§r — biomes
- §e{key:light}§r — lighting (auto / day / night), §e{key:chunk_grid}§r — chunk grid
- §e{key:ores}§r — ore veins, §e{key:fluids}§r — underground fluids, §e{key:claims}§r — claims
- §e{key:powerfails}§r — power failures, §e{key:nodes}§r — Thaumcraft nodes
- §e{key:hostile_mobs}§r — hostile mobs, §e{key:passive_mobs}§r — neutral mobs, §e{key:friendly_mobs}§r — friendly mobs
- §e{key:pets}§r — pets, §e{key:players}§r — players

§fOn the world map (fixed):§r
- §eSpace§r — back to the player, §eEsc§r — close
- §eQ§r / §eE§r — turn the 3D view

# {icon:buttons} Map buttons
The top of the map has §ficons§r; hover one to see its name.

§fLeft:§r
- §bGear§r — settings
- §bFlag§r — waypoint list
- §bBar chart§r (§fStats§r) — disk space of the maps of §fall worlds§r, and for §fthis world§r (all dimensions or one, picked from a drop-down list): the 2D and 3D map, waypoints, GregTech ore veins, underground fluids and Thaumcraft nodes (with those mods); sizes are counted again each time it opens
- §bBin§r — clean up: empty the logs folder, delete the 2D or 3D map of all dimensions of this world, or the 2D, 3D or whole map of one dimension (each button asks again). Waypoints are kept
- §bCamera§r — a picture of the whole map (2D or 3D, as shown). Saved to §fscreenshots/wayfarmap§r, it opens in a browser and zooms down to single blocks. Pick the size: 3D from 2 to 64 px per block (and day or night), 2D from 1 to 16. §foverview.png§r is the whole map as one picture at the chosen full detail
- §bLayers§r — the §bAdd-on layers§r menu: checkboxes for ores, fluids, claims, power failures and Thaumcraft nodes (only for installed mods); it stays open to switch several

§fRight:§r
- §bCrosshair§r — follow the player: on, the map always opens at you; off, where you closed it
- §bCreeper§r — mobs: checkboxes for §fneutral mobs§r, §afriendly mobs§r, §fpets§r, §chostile mobs§r and §fplayers§r (the menu stays open); all off shows none. A §agreen§r dot means friendly mobs only, §cred§r hostile only, a dim icon nothing shown
- §bGrid§r — chunk grid
- §bModes§r — a list: §f2D map§r, §f3D map§r (isometric, like Dynmap), §f2D map without plants§r, §fTopography§r (colored by height with contour lines), §fBiomes§r and, for operators, §fArea loading§r; the icon shows the mode. In 3D §eQ§r / §eE§r turn the view, and on its right the §bquality slider§r: 8, 16, 32 or 64 px per block (more is sharper, less is quicker)
- §bHill with a tunnel§r — caves: highlighted on, with a dot auto, dim off
- §bSun§r / §bMoon§r — lighting, click to switch: §bhalf dark circle§r with a dot — auto (follows the time of day), §bsun§r — always day, §bmoon§r — always night
- §bTwo people§r — teammates online (shown while there are some)
- §bCross§r at the right end — close the map (like §eEsc§r)
- §b?§r bottom right — this help
- §bi§r in the corner next to it — about the mod: version, author, testers and links (GitHub, Boosty, Telegram)

Any button of the map except the §bgear§r and the dimension title can be hidden: §bSettings → World map → Buttons on the map§r. The §finterface scale§r is there too.

# {icon:navigation} Map navigation
- §eLeft drag§r — move the map
- §eWheel§r — zoom (towards the cursor)
- §eSpace§r — back to the player
- The map opens §fwhere you closed it§r — same zoom and dimension (with §bCrosshair§r on — always at you)
- §eRight click§r on empty space — menu: §bTeleport here§r, §bNew waypoint§r, §bQuick waypoint§r (a waypoint at once, named by its coordinates) and, on the 2D map, §bDelete region§r (the 512×512 blocks around it from the 2D map, after asking; loaded chunks come back when they change or load again)
- §eRight click§r on a waypoint — menu: §bShare§r (in chat), §bTeleport§r, §bEdit§r, §bRemove§r, §bDisable§r (gone from the world and the minimap; on this map it stays, faded, and the same menu turns it on again)

§fOther dimensions:§r click §b[0] Overworld ▾§r at the top — a list of every dimension saved in the map opens. Pick any to see its map without being there.
- Coordinates are converted for the Nether (1:8)
- Waypoints, ores and fluids are shown for the picked dimension
- §eSpace§r — back to your dimension and the player

! In another dimension you can't teleport or change claims, and the player and mobs are not shown.

Under §fglass§r the map shows what is below it, lightly tinted with the glass color (§bSettings → 2D map → See through glass§r).

The bottom left shows the coordinates under the cursor. §7(?)§r means the place is not explored yet.

# {icon:waypoints} Waypoints
A waypoint is a point with a §fname§r, an §foutline color§r and an §fitem icon§r. It shows on the map, the minimap and in the world.

- Create: §e{key:new_waypoint}§r, §eRight click → New waypoint§r or the button in the list
- Edit: §eright click§r it on the map or in the list §b(§e{key:waypoint_list}§b)
- Pick the color in the color picker: color swatch → hue, saturation, brightness
- The icon can be any item; to search, §fclick the search field§r. It is drawn §fas in the inventory§r: blocks in 3D, modded items as they look (Tinkers' tools with their parts)
- The map shows the §fdistance§r next to the name

- §bDeath marker§r — when you die, a §cDeath§r waypoint with a skull is placed there; they all go to the §fDeaths§r group (deleted, it is created again on the next death), the latest few are kept (§bSettings → Waypoints → On death§r)
- §bMap§r in the waypoint list — opens the world map with that waypoint in the middle (in its dimension)
- §bBeam§r in the editor — a §fbeacon-like beam§r in the waypoint's color goes through its column in the world, from the bottom of the world to the top (off by default)
- §bTo chat§r in the editor — sends the waypoint to the chat; players with the mod see its name and an §a[Add]§r button that adds it to theirs §fwith its group§r (created if missing)

> Long names are cut so labels don't overlap. Hover a waypoint to see the full name at the bottom.

> Very many waypoints (hundreds)? Set §bSettings → Waypoints → View distance§r: the world shows only the near ones, the maps show all.

# {icon:groups} Waypoint groups
Groups hide waypoints in bulk, for example §f"Ores"§r or §f"Bases"§r.

- Create a group in the waypoint list §b(§e{key:waypoint_list}§b)
- §eDrag a waypoint with the left button§r onto a group to move it
- The toggle next to a group hides / shows §fall its waypoints at once§r

# {icon:teleport} Teleport
! Teleporting works §fonly with permission for /tp§r on the server (or cheats in single player). Without it there are no teleport buttons.

- §eRight click → Teleport here§r — to the highest safe spot
- If the height is unknown (unexplored), the map §fasks for Y§r in a window
- The waypoint list has a teleport button for each waypoint

# {icon:caves} Caves
Cave mode shows §fa layer underground§r instead of the surface.

- §bCaves§r / §e{key:cave_mode}§r: §fauto§r — on while you are underground; §fon§r / §foff§r — always
- The §fslider§r on the right picks the height layer (16 blocks each)
- Layers are remembered: explored caves stay on the map
- Caves are §fdark§r at any time of day: only §ftorches§r and other lights show them (unless lighting is fixed to day; Nether caves stay lit)

> Caves get on the map when you walk through them — the map draws what is around you.

# {icon:biomes} Biomes and search
- §bBiomes§r — colors the map by biome (in any dimension, also in the Nether and underground); hovering shows the biome at the bottom
- The §fsearch field§r shows up at the top in biome, ore or fluid view
- Example: type §e"Ocean"§r — everything else turns §7gray§r and oceans get §6outlined§r
- §eEsc§r in the field clears the search, §eEnter§r leaves the field

# {icon:topo} Topography
- §bModes → Topography§r — the surface by height, in JourneyMap's look: water in flat §9dark blue§r (lighter along the shore), land in flat bands from §2dark green§r at the shore through gray-green and slate to §dlavender§r and nearly §fwhite§r peaks
- Dark brown §fcontour lines§r between the bands join places of equal height: close lines mean a steep slope
- Biomes and topography replace each other: turning one on turns the other off. Works on the minimap too
- The line step and the lines themselves — §bSettings → 2D map§r
- Made from the heights of the explored surface; caves and the 3D map are not shown in this view

# {icon:view} Map view
- §bLighting§r (sun / moon) — one button, round and round: §fauto§r (the map §ffollows the time of day§r) → §falways day§r → §falways night§r; at night places lit by torches, lamps and lava glow
- §bGrid§r — the 16×16 chunk grid
- §b3D map§r — the world isometric like Dynmap, drawn from the blocks themselves (textures, grass and leaves in biome colors, sky and torch light, shade under trees, water as one body with the floor showing in the shallows, Chisel connected textures, tile entities (chests, signs, machines), GregTech pipes and cables, crops and beds as the game draws them; torch light at night, plants, slabs, stairs, fences). §eQ§r / §eE§r or the arrow button turn the view to the 4 sides. Blocks are recorded as you walk around; places explored before or by your team show as pillars of the flat map colors until you visit them. Tiles are drawn in the background, the far out levels are saved to disk. Under roofs and overhangs the real floor shows, not solid stone (how deep to look — §bSettings → 3D map → Look under roofs§r). Surface only; biomes and caves stay flat. Waypoints, players and the team show in 3D too, add-on layers, the grid and mobs only on the flat map
- §bMobs§r — a menu of checkboxes: neutral, friendly, pets, hostile, players. The button shows who is shown now
- Mobs and players show as §fface icons§r; detailed filters are in the settings §b(Entities)

# {icon:ores} Ores and fluids
Needs the §fVisualProspecting§r mod (GTNH). Turned on with the §bOres§r and §bFluids§r checkboxes in the §bAdd-on layers§r menu (layers icon, top left) — they are §fexclusive§r, only one is on.

- Hover a vein — a tooltip with its ores
- §eRight click a vein → Track§r — a marker with distance appears in the world
- §eRight click a vein → Depleted§r — marks the vein as mined out (drawn dim)
- The search at the top finds ores and fluids by name

! Veins show up only after prospecting (mined ores, samples, scanners).

# {icon:power} Power failures (GregTech)
When a GregTech machine runs out of energy, GregTech records a §fpower failure§r. The §bPowerfails§r checkbox in the §bAdd-on layers§r menu shows them on the map and the minimap with a §cred frame§r and a lightning icon.

- Hover — which machine, coordinates, how many times and when it last failed
- Zoomed in, the machine and how long ago are written under the icon
- §eRight click → Clear power failure§r — forget it (like in GregTech)
- §eRight click → Place a waypoint here§r — a waypoint to the machine
- The search at the top finds failures by machine name

> Your whole team sees them: the GregTech server sends them.

# {icon:nodes} Thaumcraft nodes (TCNodeTracker)
Needs §fThaumcraft§r and §fTCNodeTracker§r. The nodes you found and recorded with TCNodeTracker show on the map and the minimap — a node icon in the color of its §fstrongest aspect§r with that aspect inside. Turned on with the §bThaumcraft nodes§r checkbox in the §bAdd-on layers§r menu.

- Hover — node type, modifier, every aspect with its amount, and the coordinates
- Zoomed in, the main aspects are written under the icon
- §eRight click a node → Track§r — a node marker with the distance appears in the world, like a tracked vein (seen through blocks)
- §eRight click a node → Remove node§r — removes it from TCNodeTracker's list
- The search at the top finds aspects: §e"ignis"§r, §e"aer ordo"§r — other nodes fade

# {icon:claims} Claims (ServerUtilities)
Needs §fServerUtilities§r and §fNavigator§r on the server. Turn on the §bClaims§r checkbox in the §bAdd-on layers§r menu.

§fLeft drag a rectangle:§r
- §eCtrl§r — claim chunks
- §eShift§r — load chunks (chunkload), your own only
- §eCtrl+Shift§r — both

§fRight drag a rectangle:§r
- §eCtrl§r — unclaim
- §eShift§r — unload
- §eCtrl+Shift§r — §cremove everything§r (load and claim)

Colors: every claim in its team's color, yours too (a bit brighter). Chunk loaded chunks are outlined in black, one outline around each loaded area.

! Claims are shown and changed §fonly in the dimension you stand in§r: the ServerUtilities server always uses the player's dimension. To claim in the Nether, go to the Nether.

! A selection is at most §f64×64§r chunks. Claim and load limits come from the server — see the counter at the bottom right.

# {icon:team} Team map
Every player has §ftheir own map§r. If the mod is on the §fserver§r too (with §fServerUtilities§r), a team's map becomes §ashared§r.

- Create or join a team — §fyour whole map§r (all dimensions and caves) is sent to the team in the background, and you get the team's
- The members' maps §fmerge§r: the most recently mapped version of every part wins
- Teammates' new discoveries appear on your map right away, and yours on theirs
- Join later — you §fget everything§r the team mapped meanwhile, §fin every dimension§r (yours first), and what you mapped goes to the team
- Dimensions the team explored are open right away in the list under the map title — §fwithout going there§r
- Stored on the server, in the world's §7wayfarmap/teams§r folder

- §fTeammates are always shown§r on the map and the minimap — their head in a §9blue frame§r with their name, even far away and in another dimension (when looking at it)
- The §bTwo people§r icon at the top right (while someone of the team is online) lists your teammates and their dimension; a click moves the map to them, even into another dimension

! Without a team your map stays yours only — nobody else's reaches you.
> To turn it off: §bSettings → 2D map → Team map§r.

# {icon:chunkload} Loading an area (/wf chunkload)
The command maps a §flarge area around you§r without walking it: the server loads (and generates if needed) the chunks, and the map draws them.

- §e/wf chunkload 2d <radius>§r — the flat map, radius in chunks
- §e/wf chunkload 3d <radius>§r — the flat and the 3D map (slower)
- §e/wf chunkload status§r — how far it got
- §e/wf chunkload stop§r — stop it
- §e/wf regionload 2d|3d <radius>§r — only the chunks saved in the world, nothing generated; §efull§r instead of the radius — every region file of the dimension

§fFrom the map:§r §bModes → Area loading§r (operators only) shows the chunks §aon the map§r (green), those §7saved in the world§r but not mapped yet (gray) and those §cqueued§r (red).
- §eCtrl+LMB drag§r — load the gray chunks of the rectangle from the regions, as they are (nothing generated)
- §eShift+LMB drag§r — generate the chunks of the rectangle (those never made too)
- §eCtrl+Shift+LMB drag§r — generate them with every cave layer
- §eCtrl+RMB drag§r — §cdelete§r the rectangle from the map at once (taken off the queue too). Chunks loaded around you are mapped again right away
- §eShift+RMB drag§r — cancel: the queued (red) chunks of the rectangle are taken off the queue
- §bLoad all from regions§r — every chunk saved in this dimension, at once (asks first; nothing generated)
- §bDelete dimension map§r — the whole map of this dimension (asks first; waypoints stay)
- With §bSettings → 3D map → Record blocks§r on, everything above is done for the 3D map too

- The world map shows it at the bottom: chunks done and §fseconds elapsed§r
- Leave the world or go to another dimension — it pauses and goes on when you are back
- Speed — §bSettings → Commands§r

! Needs operator rights (cheats in single player). On a shared server a large radius loads the server.

# {icon:settings} Settings
The §bSettings§r button on the map opens all options by category:

- §fMinimap§r — size, §fposition anywhere on screen§r (dragged with the mouse), zoom, coordinates and biome, §fround shape§r and §frotate with view§r (view direction always up). The compass points N, E, S, W are marked on the minimap's edge
- §fWorld map§r — §finterface scale§r (the map and the mod's screens don't depend on Minecraft's GUI scale; Auto fits the window) and which §fbuttons§r the map shows
- §f2D map§r — caves, lighting, colors, glass, mod layers, scan speed, autosave, team map
- §f3D map§r — 3D view, view side, quality, smoothing, recording blocks, copy speed, looking under roofs
- §fEntities§r — players, hostile and passive mobs, icon limit, vertical range
- §fWaypoints§r — where they show, size, label width, view distance, §fdeath markers§r
- §fCommands§r — how fast §e/wf chunkload§r runs on the server and the client, batch size
- §fLogs§r — detailed logs of the 2D and 3D map to track down problems

Within a category the options are grouped into sections. Options that depend on a switch sit indented under it and are dimmed while it is off.

> Hover an option's name to see its full description.
