Skip to content

A javascript client plugin for Overviewer which reads information from a socket server to display player locations and other information on an Overviewer map.

Notifications You must be signed in to change notification settings

ArchmageInc/Overviewer-Info-Plugin

Repository files navigation

Overviewer Info Plugin

This JavaScript plugin is designed to integrate with an Overviewer map to layer in additional information. Most importantly, player location information. It uses a Web Socket to receive data, and has been developed in tandem with PlayerLocations, a server plugin to send this data over a Web Socket. It has been a tinker project and I have added other features, some specific to my implementation.

  • Player Information
    • Location, including dimension*
    • Health
    • Air
    • Hunger
    • Level
  • Server Information
    • Current world time
  • Navigation
    • Collapsible list of current players
    • Selectable players with zoom to location

NOTE Dimensions are not as straight forward as Minecraft players might think. Overviewer does not exactly provide the dimension information in the tilesets it outputs. Instead, this has to rely on the worlds dictionary or title display name in the configuration to contain specific cues.

Also, the conversion values between dimensions is hard-coded (i.e. 8:1 overworld:nether).

Usage

Download the Overviewer-Info-Plugin.zip from the Releases and extract the files into the directory serving your Overviwer map. In the index.html file insert the following in the <head> section.

<script type="text/javascript" src="overviewer-info-plugin.js"></script>
<script type="text/javascript">OverviewerInfoPlugin.start()</script>

Alternatively, the extracted files and a modified index.html can be placed in an assets directory referenced in the configuration for Custom Web Assets.

Contributing

IDK, create a fork, create a PR, maybe write some unit tests because I sure didn't. I'll probably forget that this repo exists until I finally look at my email after three years and see people arguing about exposing an RCON port over the web to JavaScript clients. SHEESH I can't believe people thought that would be a good idea.

Bugs & Issues

Sure, log an issue in the Issues tracker. Maybe I'll get to it, but I'd recomend first reading the Contributing section.

About

A javascript client plugin for Overviewer which reads information from a socket server to display player locations and other information on an Overviewer map.

Resources

Stars

Watchers

Forks

Packages

No packages published