LiveAtlas/README.md

# LiveAtlas 
A [Dynmap](https://github.com/webbukkit/dynmap) and [Pl3xmap](https://github.com/NeumimTo/Pl3xMap)/[Squaremap](https://github.com/jpenilla/squaremap) frontend built with [Vue.js](https://github.com/vuejs/vue) and Typescript.

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

LiveAtlas is an alternative frontend for Dynmap, Pl3xmap and Squaremap, which aims to provide a more modern interface and improved performance for busy maps. LiveAtlas is a drop-in replacement for Dynmap; Pl3xmap and Squaremap maps are supported with some additional configuration.

Development is ongoing, but the major features of each map plugin are supported.

You can see it in action [here](https://minecraft.rtgame.co.uk/map/build)

## Supported map features

| Feature | Dynmap | Pl3xmap/Squaremap |
| --------------- | --------------- | --------------- |
| Viewing maps | ✅ | ✅ |
| Markers | ✅ | ✅ |
| Player markers | ✅ | ✅ |
| Player facing direction | n/a | ✅ |
| Popups | ✅ | ✅ |
| Tooltips | n/a | ✅ |
| Tile updates | ✅ | ✅ |
| Marker updates | ✅ | ❌ |
| Following players | ✅ | ✅ |
| Location display | ✅ | ✅ |
| Link button | ✅ | ✅ |
| Link button URLs | ✅ | ✅ |
| Clock | ✅ | n/a |
| Logos | ✅ | n/a | 
| Chat |  ✅ | n/a |
| Chat balloons | ✅ | n/a |
| Login/register | ✅ | n/a |
| Inactivity timeout | ❌ | n/a |
| Custom player head URLs | n/a | ❌ | 
| Custom map icons | ✅ | ✅ |

## Supported Browsers
- Chrome 66+
- Edge 18+
- Firefox 60+
- Opera 53+
- Safari 11.1+

IE is not supported

## Download
LiveAtlas is available on [SpigotMC](https://www.spigotmc.org/resources/liveatlas-a-dynmap-frontend-for-the-modern-web.86939/)

Dev builds are available in [Github actions](https://github.com/JLyne/LiveAtlas/actions/workflows/main.yml)

## Installation
[See the wiki](https://github.com/JLyne/LiveAtlas/wiki/Installation)

## Customisation
The index.html file can be edited to add custom favicons, styles or analytics, just like the map plugins original UIs. All LiveAtlas messages can also be modified here for translation purposes.
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, Pl3xmap or Squaremap teams 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`
Update README.md 2021-12-27 23:09:39 +00:00			`A [Dynmap](https://github.com/webbukkit/dynmap) and [Pl3xmap](https://github.com/NeumimTo/Pl3xMap)/[Squaremap](https://github.com/jpenilla/squaremap) frontend built with [Vue.js](https://github.com/vuejs/vue) and Typescript.`
Add README.md 2020-12-17 14:46:48 +00:00
Update README.md 2021-09-07 17:48:32 +00:00			`![A LiveAtlas screenshot](https://minecraft.rtgame.co.uk/liveatlas/liveatlas4.png)`
Update README.md 2020-12-17 16:09:16 +00:00
Update README.md 2021-12-28 14:08:35 +00:00			`LiveAtlas is an alternative frontend for Dynmap, Pl3xmap and Squaremap, which aims to provide a more modern interface and improved performance for busy maps. LiveAtlas is a drop-in replacement for Dynmap; Pl3xmap and Squaremap maps are supported with some additional configuration.`
Add README.md 2020-12-17 14:46:48 +00:00
Update README.md 2021-12-28 14:07:46 +00:00			`Development is ongoing, but the major features of each map plugin are supported.`
Add README.md 2020-12-17 14:46:48 +00:00
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
Update README.md 2021-09-07 18:10:40 +00:00			`## Supported map features`

Update README.md 2021-12-27 23:09:39 +00:00			`\| Feature \| Dynmap \| Pl3xmap/Squaremap \|`
Update README.md 2021-09-07 18:10:40 +00:00			`\| --------------- \| --------------- \| --------------- \|`
			`\| Viewing maps \| ✅ \| ✅ \|`
			`\| Markers \| ✅ \| ✅ \|`
			`\| Player markers \| ✅ \| ✅ \|`
Update README.md 2021-12-10 18:30:54 +00:00			`\| Player facing direction \| n/a \| ✅ \|`
Update README.md 2021-09-07 18:10:40 +00:00			`\| Popups \| ✅ \| ✅ \|`
			`\| Tooltips \| n/a \| ✅ \|`
			`\| Tile updates \| ✅ \| ✅ \|`
			`\| Marker updates \| ✅ \| ❌ \|`
			`\| Following players \| ✅ \| ✅ \|`
			`\| Location display \| ✅ \| ✅ \|`
			`\| Link button \| ✅ \| ✅ \|`
			`\| Link button URLs \| ✅ \| ✅ \|`
			`\| Clock \| ✅ \| n/a \|`
			`\| Logos \| ✅ \| n/a \|`
			`\| Chat \| ✅ \| n/a \|`
			`\| Chat balloons \| ✅ \| n/a \|`
			`\| Login/register \| ✅ \| n/a \|`
			`\| Inactivity timeout \| ❌ \| n/a \|`
Update README.md 2021-09-28 13:30:03 +00:00			`\| Custom player head URLs \| n/a \| ❌ \|`
Update README.md 2021-09-30 23:26:33 +00:00			`\| Custom map icons \| ✅ \| ✅ \|`
Add README.md 2020-12-17 14:46:48 +00:00
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
Update README.md 2021-09-07 20:17:33 +00:00			`IE is not supported`

Update README.md 2021-07-18 17:21:50 +00:00			`## Download`
			`LiveAtlas is available on [SpigotMC](https://www.spigotmc.org/resources/liveatlas-a-dynmap-frontend-for-the-modern-web.86939/)`

			`Dev builds are available in [Github actions](https://github.com/JLyne/LiveAtlas/actions/workflows/main.yml)`

Add README.md 2020-12-17 14:46:48 +00:00			`## Installation`
Update README.md 2021-09-07 18:42:06 +00:00			`[See the wiki](https://github.com/JLyne/LiveAtlas/wiki/Installation)`
Add README.md 2020-12-17 14:46:48 +00:00
			`## Customisation`
Update README.md 2021-12-28 14:07:46 +00:00			`The index.html file can be edited to add custom favicons, styles or analytics, just like the map plugins original UIs. All LiveAtlas messages can also be modified here for translation purposes.`
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 2021-12-27 23:09:39 +00:00			`Please do not contact the Dynmap, Pl3xmap or Squaremap teams 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/).`