Giter Site home page Giter Site logo

wolfensteijn / valheim-webmap Goto Github PK

View Code? Open in Web Editor NEW

This project forked from h0tw1r3/valheim-webmap

0.0 0.0 0.0 856 KB

Live Valheim world map on the web! Server side only BepInEx mod.

License: MIT License

JavaScript 32.15% C# 55.87% CSS 5.26% HTML 6.72%

valheim-webmap's Introduction

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

  • A explorable map of your Valheim world in your browser that you can zoom with the mousewheel or pinch zoom on mobile.
  • Players can place their own pins with chat commands (see below for more info)
  • Map pings from in game players will show up on the web map as well.
  • Connected players list.
  • Auto follow player feature.
  • Connect and chat messages.
  • Discord server status and player join/leave notifications.

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:

  • !pin - Place a "dot" pin with no text on the map where you are currently standing.
  • !pin my pin name - Place a "dot" pin with "my pin name" under it on the map where you are currently standing.
  • !pin [pin-type] [text] - Place a pin of a certain type with optional text under it on the map where you are currently standing.
    • Pin types are: dot, fire, mine, house and cave. Example command: /pin house my awesome base
  • !undoPin - Delete your most recent pin.
  • !deletePin [text] - Delete the most recent pin that matches the text exactly.

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.