This is a fork of the original by Billy
LiveMap is a Google Maps-like map for Vintage Story that can be viewed in a browser. Easy to set up when making use of LiveMap's integrated webserver which works out-of-the-box, while also available to be integrated into existing websites running on Apache and the like.
Features
- Integrated Web Server: Out-of-the-box web hosting for the map, with no external dependencies required.
- Real-time Updates: The map updates automatically as players explore and modify the world.
- Built-in Layers:
- Players: Track the location and health of online players.
- Traders: Automatically mark discovered traders on the map.
- Translocators: Keep track of discovered translocators for easy navigation.
- Spawn: Highlights the world's default spawn point.
- Rendering Styles: Choose between multiple map styles, including Basic and Sepia.
- High Performance: Asynchronous rendering and task management ensure minimal impact on server performance.
- Extensive API: Easy for other mod developers to add custom layers, markers, and more.
- Customizable UI: Fully configurable logo, title, and attribution settings.
Downloads and Releases
All releases can be downloaded from the VintageStory ModDB site at:
https://mods.vintagestory.at/vslivemaprevival
Demo
A live demo of LiveMap can be accessed at:
For Developers
There is an extensive API that allows you to automate adding/updating your own layers and markers on the map.
Documentation
Documentation is automatically generated and hosted on GitHub Pages. You can find it at:
https://mja00.dev/VS-LiveMap-Revival/
To build the documentation locally, ensure you have Doxygen installed and run:
The generated documentation will be located in docs/html.
Building from Source
Prerequisites:
- .NET SDK 8.0
- npm
- Node.js
- ReSharper Extension (optional but highly recommended)
To build the project run the following command:
And the final zip will be located at bin/mods/livemap.zip if there were no errors.
Running Tests
To run the automated test suite:
Web Tests
C# Tests
Special Thanks
 |  |  |
 |  |  |
