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

Updated Installation (markdown)

James Lyne 2021-09-07 19:35:17 +01:00
parent 0e7160a06c
commit 4ed6ddf697
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Installation.md

@ -8,17 +8,22 @@ If you don't know which guide to follow, you probably want the internal webserve
LiveAtlas is a drop-in replacement for the default Dynmap UI and should work without additional configuration. 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) 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. 2. Extract into the `plugins/dynmap/web` folder on your Minecraft server.
3. Set index.html as read-only. This will prevent Dynmap overwriting it after every update. The existing index.html should be overwritten.
4. Clear any CDN caches you may have. If you don't know what this means then don't worry about it. 3. 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. 5. Done.
## Pl3xmap internal webserver installation ## Pl3xmap internal webserver installation
LiveAtlas by default expects a local Dynmap installation, and requires some extra configuration to work with the Pl3xmap internal webserver. 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) 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. 2. Extract into the `plugins/Pl3xMap/web` folder on your Minecraft server.
3. Open Pl3xmap's config.yml and set `auto-update` to `false`. This will prevent Pl3xmap overwriting LiveAtlas files. 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. 4. Update `window.liveAtlasConfig` in index.html.
Update the `servers` config to the below: Update the `servers` config to the below:
@ -33,17 +38,20 @@ LiveAtlas by default expects a local Dynmap installation, and requires some extr
5. Remove the `standalone/config.js` `<script>` tag from index.html 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 Pl3xmap, and removing this `<script>` will avoid an unnecessary extra request.
6. Clear any CDN caches you may have. If you don't know what this means then don't worry about it. 6. Clear any CDN caches you may have.
If you don't know what this means then don't worry about it.
7. Done. 7. Done.
## External webserver installation ## 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. Pl3xmap and multiple server support require additional configuration.
1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest) 1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
2. Extract into your webserver root. Any existing index.html should be overwritten. 2. Extract into your webserver root.
Any existing index.html should be overwritten.
3. Configure as required 3. Configure as required
* For a single dynmap installation no additional configuration should be required * For a single dynmap installation no additional configuration should be required
* For a single Pl3xmap installation, follow step 4 of the [internal webserver installation]() * For a single Pl3xmap installation, follow step 4 of the [internal webserver installation]()
* For multiple servers, see [this page]() * For multiple servers, see [this page]()
4. Clear any CDN caches you may have. If you don't know what this means then don't worry about it. 4. Clear any CDN caches you may have.
If you don't know what this means then don't worry about it.
5. Done 5. Done