neocturne/MinedMap
1
0
Fork 0
mirror of https://github.com/neocturne/MinedMap.git synced 2025-03-04 17:23:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

README.md: some rewording

Browse source
This commit is contained in:
Matthias Schiffer 2024-03-03 23:43:42 +01:00
parent 00eea45375
commit bccd6d6cb4
Signed by: neocturne
GPG key ID: 16EF3F64CB201D9C
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -22,10 +22,12 @@ based on [Leaflet](https://leafletjs.com/). The map renderer is heavily inspired
## How to use ## How to use
Download both the release that matches your platform, as well as the platform- Download the binary release that matches your platform from the Github release
independant viewer archive. Extract the viewer archive. This directory will be made page (or install from source using `cargo`), as well as the platform-independent
publicly accessible on a web server and will contain both the html and javascript to viewer archive. Extract the viewer archive. The extracted directory contains the
operate the viewer, as well as the image data generated by MinedMap. HTML and JavaScript to operate the viewer and will be made publicly accessible
on a web server. The image data generated by MinedMap will be stored in the
`data` subdirectory of the extracted viewer.
Minecraft stores its save data in a directory `~/.minecraft/saves` on Linux, Minecraft stores its save data in a directory `~/.minecraft/saves` on Linux,
and `C:\Users\<username>\AppData\Roaming\.minecraft\saves`. To generate MinedMap and `C:\Users\<username>\AppData\Roaming\.minecraft\saves`. To generate MinedMap
@ -52,9 +54,9 @@ This test server is very slow and cannot handle multiple requests concurrently,
a proper webserver like [nginx](https://nginx.org/) or upload the viewer together with a proper webserver like [nginx](https://nginx.org/) or upload the viewer together with
the generated map files to public webspace to make the map available to others. the generated map files to public webspace to make the map available to others.
If you are uploading the directory to a remote webserver, you do not need to upload the If you are uploading the directory to a remote webserver, you do not need to upload the
`<viewer>/data/processed` directory, as that is only used locally to make updates `<viewer>/data/processed` directory, as that is only used locally to allow processing
process more quickly. updates more quickly.
### Signs ### Signs