LiveAtlas/README.md

# LiveAtlas 
A [Dynmap](https://github.com/webbukkit/dynmap) frontend for the modern web, built with [Vue.js](https://github.com/vuejs/vue) and typescript.

![A LiveAtlas screenshot](https://minecraft.rtgame.co.uk/liveatlas/liveatlas3.jpg)

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](https://minecraft.rtgame.co.uk/map/build)

## 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 66+
- Edge 18+
- Firefox 60+
- Opera 53+
- Safari 11.1+

## Installation
Using an [external webserver](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) is recommended.

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

### Default internal webserver
1. Download the latest release.
2. Extract into `plugins/dynmap/web`. The existing index.html should be overwritten.
3. (Recommended) Set index.html as readonly. This will prevent Dynmap overwriting it after every update.
4. Clear any CDN caches you may have.
5. 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:

<a href='https://ko-fi.com/jlyne' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
___
  
Cross-browser testing provided by [Browserstack](http://browserstack.com/).
Add ko-fi link 2020-12-19 01:42:08 +00:00			`# LiveAtlas`
Add README.md 2020-12-17 14:46:48 +00:00			`A [Dynmap](https://github.com/webbukkit/dynmap) frontend for the modern web, built with [Vue.js](https://github.com/vuejs/vue) and typescript.`

Update README.md 2021-05-29 17:31:28 +00:00			`![A LiveAtlas screenshot](https://minecraft.rtgame.co.uk/liveatlas/liveatlas3.jpg)`
Update README.md 2020-12-17 16:09:16 +00:00
Add README.md 2020-12-17 14:46:48 +00:00			`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.`

Update README.md 2021-05-22 01:55:40 +00:00			`You can see it in action [here](https://minecraft.rtgame.co.uk/map/build)`
Update README.md 2020-12-17 16:11:16 +00:00
Add README.md 2020-12-17 14:46:48 +00:00			`## Supported Dynmap features`
			`- Viewing maps`
			`- Layers`
			`- Player markers`
			`- Custom markers, areas, circles and lines`
			`- Popups`
Update README.md 2020-12-19 01:58:48 +00:00			`- Tile/marker updates`
Add README.md 2020-12-17 14:46:48 +00:00			`- Following players`
			`- Location control`
			`- Link control`
			`- Digital/time of day clock control`
			`- Logo controls`
			- New urls (`#world;map;1,1,1,1`)
Update README.md 2020-12-21 19:30:28 +00:00			- Legacy urls (`?worldname=world&mapname=map&z=1&y=1&z=1`)
Update README.md 2021-01-02 18:54:27 +00:00			`- Viewing chat messages`
Update README.md 2021-01-06 02:24:45 +00:00			`- Chat balloons`
Update README.md 2021-01-25 13:52:34 +00:00			`- Sending chat messages`
Add README.md 2020-12-17 14:46:48 +00:00
			`## Not supported right now`
			`- Login/register`
			`- Inactivity timeout`

Update README.md 2021-05-16 20:23:02 +00:00			`## Supported Browsers`
Update README.md 2021-05-25 19:03:19 +00:00			`- Chrome 66+`
Update README.md 2021-05-16 20:23:19 +00:00			`- Edge 18+`
			`- Firefox 60+`
Update README.md 2021-05-25 19:03:19 +00:00			`- Opera 53+`
Safari 11.1 seems to work now 2021-05-25 22:31:33 +00:00			`- Safari 11.1+`
Update README.md 2021-05-16 20:23:02 +00:00
Add README.md 2020-12-17 14:46:48 +00:00			`## Installation`
			`Using an [external webserver](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) is recommended.`

			`### External webserver`
			`1. Download the latest release.`
			`2. Extract into your webserver root. Any existing index.html should be overwritten.`
			`3. Clear any CDN caches you may have`
			`4. Done.`

			`### Default internal webserver`
			`1. Download the latest release.`
			2. Extract into `plugins/dynmap/web`. The existing index.html should be overwritten.
Update README.md 2020-12-25 21:25:12 +00:00			`3. (Recommended) Set index.html as readonly. This will prevent Dynmap overwriting it after every update.`
Add README.md 2020-12-17 14:46:48 +00:00			`4. Clear any CDN caches you may have.`
			`5. Done.`

			`## Customisation`
Update README.md 2020-12-19 02:00:04 +00:00			`The index.html file can be edited to add custom favicons, styles or analytics, just like the original Dynmap.`
Add README.md 2020-12-17 14:46:48 +00:00			`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.`

Update README.md 2020-12-17 16:09:16 +00:00			`Please do not contact the Dynmap team regarding any issue with LiveAtlas. They will be very upset.`
Add ko-fi link 2020-12-19 01:42:08 +00:00
			`## Donate`
			`If you appreciate my work, feel free to:`

Update README.md 2021-01-25 02:07:36 +00:00			`<a href='https://ko-fi.com/jlyne' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>`
Update README.md 2021-01-25 02:06:26 +00:00			`___`
Update README.md 2021-01-25 02:07:36 +00:00
			`Cross-browser testing provided by [Browserstack](http://browserstack.com/).`