# Lodeway | A live web map for your server, hosted for you

**Lodeway puts a live, Google-Maps-style map of your server on the web at
`your-name.lodeway.app`.** Install one file, run one command, share the link. No port
to open, no config to edit, no render eating your CPU.
**See it for yourself:** [demo.lodeway.app](https://demo.lodeway.app), a real survival
world that has been running since 2011.

## Setup, in its entirety

1. Drop `lodeway.jar` into `/plugins` and restart. There is no config file.
2. Run `lodeway setup` in the console. It prints a short link like
`lodeway.app/s/K7M2-QX9F`. Open it and confirm your address.
3. Your map is live at `your-name.lodeway.app` within seconds, ready to share.
Share links point at any coordinate.
Prefer starting in the browser? Enter your address at
[lodeway.app](https://lodeway.app) first. It pings your server, detects your software
and version, and hands you the right file.
## What it costs your server
Practically nothing:

Your server only streams region files out. We decode, render, and serve the map on
our side. That is why Lodeway works on shared hosting, and on hosts that do not allow
extra ports at all.
## What leaves your server
Lodeway uploads your world's **region files** (terrain data) to our rendering service,
on demand, over an outbound connection the plugin opens. If you keep the player
overlay on (it is on by default, one toggle turns it off), current **player names and
positions** are shared while players are online.
No chat, no inventories, no command history, no personal data. Your map is public at
its URL unless you keep the URL private.
## How does it stack up?
BlueMap, Dynmap, and squaremap are free, open source, actively maintained, and
self-hosted. We think Lodeway offers a better player and admin experience, but they
are excellent options too:

No marker API and no 3D free-camera yet. If you want those today, BlueMap is superb.
If you want a map that costs your server nothing to have, that is us.

## FAQ
**Does this work on shared hosting, or hosts with no extra ports?**
Yes! The plugin only opens outbound connections. There is no web
port to forward, no reverse proxy, and no tile directory filling your disk quota.
**Do my players need to install anything?**
No. The map is a website. Players open the link in any browser, on any device.
## Links
- Website: [lodeway.app](https://lodeway.app)
- Live demo: [demo.lodeway.app](https://demo.lodeway.app)
*NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR
MICROSOFT. Lodeway is an independent project; Minecraft is a trademark of Mojang
Synergies AB.*
Lodeway is a free Minecraft Java mod. Compatible with Minecraft 1.10, 1.10.1, 1.10.2, 1.11 and newer. Downloaded 11 times (via Hangar). Download it and open it directly in the game.