Skip to content

Commit ec71504

Browse files
committed
add readme info
1 parent 818dcb1 commit ec71504

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# MCMapViewer
2-
A simple 3rd party tool to view minecraft maps without the game.
2+
3+
A tool to view and edit Minecraft maps.
4+
5+
---
6+
7+
## Loading
8+
9+
To load maps, select either the worlds `data` folder or a map file. Map files file names use the format `map_<id>.dat`, so e.g. `map_15.dat` is a valid map file name.
10+
11+
## Editing
12+
13+
Left-click on one of the map files in the list view on the left side to open it. Once a change has been made, you can not switch to a different map file until it has been saved or reloaded. An unsaved map file has a `*` next to its name.
14+
15+
### Banners
16+
17+
To add a banner to the map, right-click anywhere on the map.
18+
A banner's color can be changed by right-clicking on the banner and then selecting a new color. When clicking the red cross, the banner is deleted.
19+
The banner's text can be changed by right-clicking on its text. The text is always saved in JSON format.
20+
21+
### Other Icons
22+
23+
You might wonder: Why the hell does it support banners, but not the fancy other icons like on treasure maps you can acquire from Cartographers?
24+
The answer is that those icons are unfortunately *not* saved in the map file, but per-item in the minecraft world files. You may want to look at [MCA Selector](https://github.com/Querz/mcaselector) to edit them.
25+
26+
## Importing
27+
28+
When a map file has been loaded, a custom image can be imported and squeezed into the Minecraft's map format.

0 commit comments

Comments
 (0)