Back to mods

Vintage Story Mod DB · Vintage Story mod

Livemap

Live Map A Dynmap-style live web map for Vintage Story - but lighter, faster, and in 3D. Live Map turns your server into a web map that anyone can open in a browser at http://your-server:8123/. The map updates as players explore and build, and every online p

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Livemap release should I use?

Updated today
Latest stable file 1.2.0
Game version 1.22.0, 1.22.1, 1.22.2
Loader Built-in Vintage Story mod system

Livemap 1.2.0 targets 1.22.0, 1.22.1, 1.22.2. Do not install it on the client. It must be installed on the dedicated server. No extra mods listed for this file.

Where it goes

Is Livemap required on the client, server, or both?

Do not install it on the client. It must be installed on the dedicated server.

Client Not supported
Dedicated server Required
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This Vintage Story file is marked server-only.

What else does Livemap 1.2.0 need?

1.2.0. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Livemap without breaking your instance.

Built for Livemap 1.2.0. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.2.0. It targets 1.22.0, 1.22.1, 1.22.2; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Do not install it on the client. It must be installed on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.2.0. It opens that exact file at the source.

About this project

What does Livemap add?

Live Map

A Dynmap-style live web map for Vintage Story - but lighter, faster, and in 3D.

Live Map turns your server into a web map that anyone can open in a browser at http://your-server:8123/. The map updates as players explore and build, and every online player shows up as a live dot moving in real time.

No client mod needed. Install it on the server and share the link.

Features

2D map

  • Smooth continuous zoom from single blocks to the whole explored world
  • Colours taken from the game's own block textures, with climate tinting for grass, leaves and water
  • Hill shading, water depth, "Elevation" style, chunk/region grid
  • Hover a block to see its name and coordinates (relative to spawn, like in game)

3D view

  • The same world as a 3D landscape (three.js): blocks up close, smooth relief in the distance
  • Automatic level of detail, transparent water, adjustable vertical exaggeration and brightness

Live players

  • One dot per player, with name and heading, moving smoothly
  • Player list: click to jump to someone, or follow them in 2D or 3D
  • In-game date and time shown on the page

Real-time updates

  • Changed chunks are re-rendered within seconds and pushed to open pages over WebSocket

Controls

  • Mouse drag, mouse wheel and touch gestures (mobile friendly)
  • ZQSD / WASD / arrow keys to move, Shift to go faster, in 2D and 3D
  • Shareable links: position, zoom, 2D/3D mode and followed player are kept in the URL

Interface in English by default, French available from the sidebar.

Lightweight by design

  • Almost nothing on the game thread. Only the surface of a changed chunk is read, using the height map the server already keeps, within a small time budget per tick.
  • Everything else runs on a low-priority background thread: colours, compression, saving and zoom levels. Unchanged chunks are never rewritten.
  • The browser does the drawing. The server sends compact pre-compressed data tiles (about 25 KB each). Browsers keep them in a persistent cache and only download them again when they change, even across visits.
  • Built-in web server. No extra software is needed, and a slow visitor can't slow down the game.

Installation

  1. Drop livemap_x.y.z.zip as is (no need to unzip) into your server's Mods folder.
  2. Restart the server.
  3. Open TCP port 8123: firewall, and port forwarding on your router if you host at home.
  4. Visit http://<server-ip>:8123/.

The map fills in as players explore. To render everything that has already been explored, run /livemap fullrender 3000 (radius in blocks).

It also works in singleplayer.

Commands

Command Privilege What it does
/livemap chat Status: port, tiles, queue, viewers
/livemap hide / show chat Hide yourself from the map (remembered)
/livemap render [radius] controlserver Re-render loaded chunks around you
/livemap fullrender [radius] controlserver Render all fully explored terrain in a radius. Never generates new terrain.
/livemap fullrender [radius] force controlserver Render the whole radius, generating missing terrain (saved to the world)
/livemap cancel controlserver Stop a full render
/livemap purge controlserver Delete all tiles and start over

Configuration

ModConfig/livemap.json (created on first start) holds the main options:

  • Port (default 8123) and BindAddress
  • Title
  • ShowPlayers, HideSpectators, HiddenPlayers
  • PlayerUpdateIntervalMs
  • MaxZoomLevel
  • MainThreadBudgetMs

Running behind nginx with HTTPS works, including under a sub-path such as /map/. A sample config is in the GitHub README.

Notes

  • Server-side only, so players don't need to download anything.
  • Only the main world dimension is mapped.
  • Autumn foliage colours are not applied yet.
  • Trees are part of the surface, so forests look spiky with a high vertical exaggeration in 3D.
  • There is no built-in password. For a private map, bind it to 127.0.0.1 behind a reverse proxy with authentication.

Source code, changelog & issues: https://github.com/Dagran10/VintageStoryLiveMap

Project description from Vintage Story Mod DB.

Pick your setup

Livemap releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

8 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Livemap versions and loaders

2 of 2 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.