Skirda/LiveAtlas
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Installation (markdown)

James Lyne 2022-01-12 01:14:33 +00:00
parent 535e1a8d57
commit 0af21ddce2
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Installation.md

@ -1,6 +1,6 @@
The installation process for LiveAtlas varies depending on where you choose to install it.
LiveAtlas will function as a drop-in replacement for a single Dynmap installation on an internal or external webserver, and with a little extra configuration for a Pl3xmap installation. Using an external webserver is highly recommended as it offers the most flexibility and compatibility.
LiveAtlas will function as a drop-in replacement for a single Dynmap installation on an internal or external webserver, and with a little extra configuration for a Squaremap or Pl3xmap installation. 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.
@ -22,17 +22,17 @@ LiveAtlas is a drop-in replacement for the default Dynmap UI and should work wit
5. Done.
## Pl3xmap internal webserver installation
LiveAtlas by default expects a Dynmap installation, and requires some extra configuration to work with Pl3xmap.
## Squaremap/Pl3xmap internal webserver installation
LiveAtlas by default expects a Dynmap installation, and requires some extra configuration to work with Squaremap or Pl3xmap.
1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
2. Extract into the `plugins/Pl3xMap/web` folder on your Minecraft server.
2. Extract into the `plugins/Squaremap/web` or `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`.
3. Open Squaremap/Pl3xmap's config.yml and set `auto-update` to `false`.
This will prevent Pl3xmap overwriting LiveAtlas files.
This will prevent LiveAtlas files from being overwritten.
4. Update `window.liveAtlasConfig` in index.html.
@ -44,11 +44,11 @@ LiveAtlas by default expects a Dynmap installation, and requires some extra conf
}
},
This will configure LiveAtlas to expect a Pl3xmap installation.
This will configure LiveAtlas to expect a Squaremap or Pl3xmap installation.
5. Remove the `standalone/config.js` `<script>` tag from index.html
This file is not required for Pl3xmap, and removing this `<script>` will avoid an unnecessary extra request.
This file is not required for Squaremap or Pl3xmap, and removing this `<script>` will avoid an unnecessary extra request.
6. Clear any CDN caches you may have.
@ -57,7 +57,7 @@ LiveAtlas by default expects a Dynmap installation, and requires some extra conf
7. Done.
## External webserver installation
LiveAtlas is a drop-in replacement for an existing Dynmap installation on an external webserver. Pl3xmap and multiple server support require additional configuration.
LiveAtlas is a drop-in replacement for an existing Dynmap installation on an external webserver. Squaremap, Pl3xmap and multiple server support require additional configuration.
1. Follow the [Dynmap](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) or [Pl3xmap](https://github.com/pl3xgaming/Pl3xMap/wiki/Internal-vs-External-Web-Server#external-server) guides for setting up an external server if required
2. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
@ -68,7 +68,7 @@ LiveAtlas is a drop-in replacement for an existing Dynmap installation on an ext
4. Configure as required
* For a single dynmap installation no additional configuration should be required
* For a single Pl3xmap installation, continue from step 4 of the [Pl3xmap internal webserver installation](https://github.com/JLyne/LiveAtlas/wiki/Installation#pl3xmap-internal-webserver-installation)
* For a single Squareap or Pl3xmap installation, continue from step 4 of the [Squaremap/Pl3xmap internal webserver installation](https://github.com/JLyne/LiveAtlas/wiki/Installation#pl3xmap-internal-webserver-installation)
* For configuring multiple servers, see [this page](https://github.com/JLyne/LiveAtlas/wiki/Configuring-Multiple-Servers)
5. Clear any CDN caches you may have.