h0tw1r3 / valheim-webmap

Live Valheim world map on the web! Server side only BepInEx mod.
MIT License
15 stars 5 forks source link

Valheim WebMap

This server side mod creates a web based map that shows live players and allows shared exploration. After port forwarding the correct port, you can share http://your_ip:port to anyone else and they can see the map too. Clients do not need to have any mods installed!

For players to show up on the map, they must set visible to other players in the in-game map screen. Press m to bring up the map settings.

Currently only works with Valheim dedicated server.

Features

screenshot

Installation

  1. Assuming you have BepInEx installed and working, place the WebMap directory in:

    Steam\steamapps\common\Valheim dedicated server\BepInEx\plugins\WebMap

  2. After starting the server for the first time a default configuration file will be created in:

    Steam\steamapps\common\Valheim dedicated server\BepInEx\config

  3. Stop the server, edit the configuration, start the server. Always stop the server before making configuration changes, otherwise they will be lost on shutdown.

Updating

If you are updating, one additional thing you and anyone else using the web map might need to do is clear your browser cache.

You may also be able to hold down the shift key and click the reload button in your browser.

Chat Commands

This mod supports placing pins with chat commands. Press Enter to start chatting in game. The commands are as follows:

If a player creates too many pins, their oldest pin will be removed. There is a setting to control how many pins a player can create.

Licence

Where applicable, assume stuff is under the MIT licence.

Credit