A Dynmap, Squaremap, Pl3xmap and Overviewer frontend for the modern web

dynmap javascript map minecraft overviewer pl3xmap squarmap typescript vue

Go to file

James Lyne b184ed775b Fix splash screen on edge mobile		2021-05-24 20:17:27 +01:00
.github/workflows	Create codeql-analysis.yml	2021-01-10 14:39:39 +00:00
public	Vite fixes	2021-05-15 21:31:42 +01:00
src	Fix splash screen on edge mobile	2021-05-24 20:17:27 +01:00
.env	1.1.0	2021-05-20 22:49:18 +01:00
.gitignore	Update .gitignore	2021-01-26 14:40:34 +00:00
FUNDING.yml	Fix filename	2020-12-19 01:43:00 +00:00
index.html	Allow customisation of context menu text	2021-05-24 18:23:35 +01:00
LICENSE.md	Add license	2020-12-16 16:54:41 +00:00
package-lock.json	Cleanup package.json	2021-05-24 16:43:21 +01:00
package.json	Cleanup package.json	2021-05-24 16:43:21 +01:00
README.md	Update README.md	2021-05-22 02:55:40 +01:00
tsconfig.json	Switch from webpack to vite	2021-05-15 20:25:03 +01:00
vite.config.ts	Add bundle analyzer	2021-05-24 16:43:13 +01:00

README.md

LiveAtlas

A Dynmap frontend for the modern web, built with Vue.js and typescript.

LiveAtlas is a drop-in replacement for the original Dynmap frontend, which aims to provide a more modern interface and improved performance for busy maps.

Development is ongoing, and there are some rough edges, but most of the Dynmap features used by a typical Minecraft server have been implemented.

You can see it in action here

Supported Dynmap features

Viewing maps
Layers
Player markers
Custom markers, areas, circles and lines
Popups
Tile/marker updates
Following players
Location control
Link control
Digital/time of day clock control
Logo controls
New urls (#world;map;1,1,1,1)
Legacy urls (?worldname=world&mapname=map&z=1&y=1&z=1)
Viewing chat messages
Chat balloons
Sending chat messages

Not supported right now

Login/register
Inactivity timeout

Supported Browsers

Chrome 63+
Edge 18+
Firefox 60+
Opera 50+
Safari 12.1+

Installation

Using an external webserver is recommended.

External webserver

Download the latest release.
Extract into your webserver root. Any existing index.html should be overwritten.
Clear any CDN caches you may have
Done.

Default internal webserver

Download the latest release.
Extract into plugins/dynmap/web. The existing index.html should be overwritten.
(Recommended) Set index.html as readonly. This will prevent Dynmap overwriting it after every update.
Clear any CDN caches you may have.
Done.

Customisation

The index.html file can be edited to add custom favicons, styles or analytics, just like the original Dynmap. You are also free to build LiveAtlas yourself to make further changes.

Building

First run npm install to install LiveAtlas dependencies. You can then either run npm run serve to start a local dev server, or npm run build to build.

Support

If you find a bug, please create an issue with as must detail as possible. I'm working on this in my spare time, so fixes are on a best effort basis, but I'll eventually find time for them.

Please do not contact the Dynmap team regarding any issue with LiveAtlas. They will be very upset.

Donate

If you appreciate my work, feel free to:

Cross-browser testing provided by Browserstack.