Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Give more info in readme #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Give more info in readme #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d0fcec
Give more info in readme
Andre601 Jun 3, 2019
db6c123
Fix broken images
Andre601 Jun 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
[Spigot]: https://www.spigotmc.org/resources/46404/
[Jenkins]: https://ci.mg-dev.eu/job/Maplands/
[BKCommonLib]: https://www.spigotmc.org/resources/39590/
[issues]: https://github.com/bergerhealer/Maplands/issues

[imgPreview]: https://user-images.githubusercontent.com/11576465/84956541-bb10b100-b0f9-11ea-95ba-0de01ea225cb.png
[imgControl]: https://user-images.githubusercontent.com/11576465/84956444-843a9b00-b0f9-11ea-9e2f-81d478f170d1.png

# Maplands
[Spigot page][spigot] | [Dev Builds][Jenkins]

Minecraft worlds in the map dimension

## About
Maplands is a work-in-progress project delivering world map rendering to Minecraft maps. Display the world in an isometric view, link maps together and create a huge overview of your server, and much more is anticipated!

You will need the latest build of [BKCommonLib] for this plugin to work correctly.

Please report bugs and ask for feature requests on the [issue page][issues]

![preview][imgPreview]

## Usage
Use `/map` to give yourself a map from maplands. You need the permission `maplands.command.map` to use this command.

### Controls
While holding the map...
- Use W, A, S or D to move the position on the map.
- If you want to move while still holding the map, swap it to your offhand.
- Sneak (Press shift) to enter or leave the menu.
- While in the menu use A and D to switch between the options.
- Jump (Press Space) to select an option.
- Pressing Jump while not in the menu re-renders the entire map.

![control][imgControl]