SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
Back to NxLabs

NxLabs / Vintage Story

WebCartographer

TBy Th3Dilli

Creates a map of a world to be browsed in a webbrowser.

WebCartographer

Description

This is a utility to export a web map from a savegame file (.vcdbs).
The final output can be hosted using nginx or apache or any other webserver.

Thanks to <span class="mention username">Drakker</span> who made the website part of this project. vs-webmap

For help, discussion or suggestions join the Discord Server



Demo: TOPS Webmap

&nbsp;

To create a webmap you will also need the client side color exported found here

WebCartographer color exporter &nbsp;

&nbsp;

Further instructions on how to use it and set it up can be found on the repository readme.


Export instructions

1. Add the Webcartographer mod to your server
2. Start the server - it will initialize the config with default values
3. Configure what the mod should do using the generated Webcartographerconfig.json
- by default it will export to the data path of your vs server or client into the "webmap" folder
- if you want to export when the server starts change "ExportOnStart": true
4. If you use a Mode other then 4 you need to add the https://mods.vintagestory.at/wcce to your client and run .exportcolors to start a export, this will send the block colors needed to construct the map to the server and start a export. If you use Mode 4 you can still use this to start a export. Once the server has the colors or in Mode 4 you can also use ExportOnStart to export when the server start. You only need to run .exportcolors again when changing or updating mods/game to ensure they have the correct color.
5. Wait till it is done, see server console, Note it will by default lock the server and kick players since the server is unusable while exporting
6. In the output directory you will find a html folder that is ready to be hosted using any webserver (nginx, apache, ...) or just open the index.html file in your webbrowser to see the map (markers wont work using that method)


Since version 0.9.0 the mod includes a integrated web server.
That means in singeplayer you only need to add the mod.
Start the world once to generate the conig, stop the world again and enable the webserver in the config EnableWebserver: true
Load back into the game
type /webc export
then wait till it is done, check youer server-main.log when it is done and it will tell you the web address of your web map when the server starts
it should say something like "Webmap server started on http://localhost:42422/"

usually that should be (game port + 2)&nbsp;

http://localhost:42422

If you host the server publically and want it to be accessible from anywhere you will need to change the Host in the config from "localhost" to "*".

Ratings & reviews

No ratings yet

Sign in to leave a rating or comment.