From 33f8030cb5cf5afb2fb3f5e3369891ac77762316 Mon Sep 17 00:00:00 2001 From: James Lyne Date: Tue, 7 Sep 2021 19:33:35 +0100 Subject: [PATCH] Created Installation (markdown) --- Installation.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 Installation.md diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..cdce641 --- /dev/null +++ b/Installation.md @@ -0,0 +1,49 @@ +The installation process for LiveAtlas varies depending on where you choose to install it. + +LiveAtlas will function as a drop-in replacement on the Dynmap internal webserver, and with a little extra configuration on the Pl3xmap internal webserver. However using an external webserver is highly recommended as it offers the most flexibility and compatibility. + +If you don't know which guide to follow, you probably want the internal webserver guide for your chosen map plugin. + +## Dynmap internal webserver installation +LiveAtlas is a drop-in replacement for the default Dynmap UI and should work without additional configuration. + +1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest) +2. Extract into the `plugins/dynmap/web` folder on your Minecraft server. The existing index.html should be overwritten. +3. (Recommended) Set index.html as read-only. This will prevent Dynmap overwriting it after every update. +4. Clear any CDN caches you may have. If you don't know what this means then don't worry about it. +5. Done. + +## Pl3xmap internal webserver installation +LiveAtlas by default expects a local Dynmap installation, and requires some extra configuration to work with the Pl3xmap internal webserver. + +1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest) +2. Extract into the `plugins/Pl3xMap/web` folder on your Minecraft server. The existing index.html should be overwritten. +3. Open Pl3xmap's config.yml and set `auto-update` to `false`. This will prevent Pl3xmap overwriting LiveAtlas files. +4. Update `window.liveAtlasConfig` in index.html. + + Update the `servers` config to the below: + + servers: { + pl3xmap: { + pl3xmap: window.location.pathname + } + }, + + This will configure LiveAtlas to expect a local Pl3xmap installation. + +5. Remove the `standalone/config.js` `