Skip to content

Latest commit

 

History

History
220 lines (158 loc) · 9.12 KB

README.md

File metadata and controls

220 lines (158 loc) · 9.12 KB
Raw

chat on Discord follow on Twitter

To download it head to the Releases section.

To run it: either double click it on it if you have the Java Runtime (JRE) or use the command line (shift+right click in the folder then open command prompt/Powershell) and type java -jar MineMap-X.X.X.jar.

This is a program to replace the old amidst with a non Minecraft based one (meaning you can run it without Minecraft installed), it is also way more efficient since it is fully multithreaded.

There are severals nice features added, you can see per layers of biome generation, find closest structures, draw circle, area and use a ruler.

Supports all Minecraft release starting from 1.0+

Demo video

Demo Video

Features

  • View Biome map for Overworld/Nether/End for all version from 1.0 till 1.16.5.
  • Load multiple seeds with a navigation tab to switch between them.
  • View structures, and some features placement on the biome map for version 1.8+.
  • View chest loot for 1.16.5 structures: Desert Pyramid, Buried Treasure, Ruined Portal and Shipwreck.
  • Multithreaded processing
  • List the N closest structure and get tp/location to those.
  • Draw line, polygon and circle as overlay to the map.
  • View proportion of biome in a pie chart.
  • Structure seed mode to see all the sister seeds (all seeds sharing the same 48 bottom bits and thus structures)
  • Themes, Shortcuts, Biome colors and structure salts are customizable.
  • Possibility to take screenshot in app via a button or shortcut.
  • View different biomes layers
  • View extra infos such as Stronghold portal order, type of structure (Bastion, Shipwreck, Village are currently supported)
  • Fully customized icons for structures and features + Mojang ones downloaded for item in chest loot.
  • 3D viewer for portals

Shortcuts

Main controls:

  • Ctrl + N : New seed
  • Ctrl + S : Screenshot
  • Ctrl + O : Open screenshot folder
  • Ctrl + Q : Close

Optional controls :

  • Alt + A : Toggle Structure Seed Mode
  • Alt + C : Change Salts
  • Alt + E : Open Settings Folder (see Configuration)
  • Alt + G : Go to Coordinates
  • Alt + K : Show Shortcuts Menu
  • Alt + L : Load Shadow Seed
  • Alt + O : Open Screenshot Folder
  • Alt + P : Go to Spawn
  • Alt + S : Go to Structure
  • Alt + Q : Close current tab
  • Alt + Shift + Q : Close current tab group

Zooming in and out:

  • Ctrl + Numpad + : Zoom in
  • Ctrl + Numpad - : Zoom out
  • Alt + Numpad + : Layer +
  • Alt + Numpad - : Layer -

Go through opened seeds (understood as an infinite tape)

  • Ctrl + Left Arrow : Previous one
  • Ctrl + Right Arrow : Next One

In a dialog type enter to activate the continue button or esc to close the dialog.

Hold alt then press H, W, U, E or B to get one of the 5 menus to open.

You can navigate the menus and press enter to use the button in it.

Specific to 3D viewer

  • Q : Enter mouse control
  • Esc : Exit mouse control
  • WASD : Move around in the world
  • Mouse movement : Look around
  • 0-9 : specific control (might not be binded to anything)

Configuration

All configuration can be found in %HOMEPATH%/.minemap (Windows) or $HOME/.minemap (Mac/Linux)

There are 4 folder here:

  • configs: User config file in json to save user preferences, can be edited manually but highly discouraged (be sure to save them after editing in a safe place, also please check your json syntax like comma at the end)
  • downloads: Assets downloaded from mojang.com with mostly the icons for the items, those are the property of Mojang AB
  • logs: log to be send if any bug happens, this will help to pinpoint the error
  • screenshots : screenshot made in the application

Command line

  • Take a screenshot :

    java -jar Minemap-<version>.jar --screenshot --seed <seed> --version <version> --pos <x> <z> --size <size> (--dimension <dimension>)

  • Don't show any update popup even if there is a update available

    java -jar Minemap-<version>.jar --no-update

  • Update Minemap without a popup

    java -jar Minemap-<version>.jar --update

Support and bugs

  • This project is still in its enfancy (while packing most of the necessary features) so bug will likely still happen inside it.

  • However, as it is actively maintained you can get a hold of me on Discord or by simply submitting a bug report in the Issues tab.

  • We also have a roadmap of future ideas here and you are welcome to open a discussion here or on Discord to ask for any feature that you deem reasonable enough (be aware for performance issues some might be denied).

Known issues

  • Linux gpu performance-> this is due to java not providing a gpu backend on some distros and using cpu rendering instead (you can try tweaking wayland, adding proprietary drivers or enabling sun opengl backend)

  • Weird artefacts appears on windows -> you are using Riva Tuner or MSI Afterburner which tampers with java swing. You should disable them or add an exception for all java.exe apps or Minemap-*.exe.

  • Minemap fails to start, maybe some config was not correctly written, go to $HOME/.minemap or %HOMEPATH%/.minemap and delete the config folder.

  • Minemap fails to update, maybe you are ratelimited by Github, please try later.

Development

You just need to have the Java JDK installed then do: git clone https://github.com/hube12/MineMap

Go in the directory and run ./gradlew run to run Minemap (we enable the no-update option)

Run ./gradlew shadowJar to generate the release jar (modify gradle.properties version variable accordingly)

Run ./gradlew release to generate the .exe and the .jar.

To use vulkan with debug and validation layers please install the vulkan Lunar SDK.

Signature and due diligence

Since 1.0.24 we sign both commits and release files (as such each exe and jar are provided with a sha512 and the jar with a signature and all of that is zipped then signed once again).

Signature can be verified with gpg --verify Minemap-<version>.zip.asc Minemap-<version>.zip.

You will need my signature which can be found here or here.

Then you will need to dearmor it: gpg -o neil_pubkey.gpg --dearmor *.asc and then import it or use directly:

gpg --no-default-keyring --keyring neil_pubkey.gpg --verify Minemap-<version>.zip.asc Minemap-<version>.zip

You can download a dearmored version here (fair warning do not open it in a text editor as it is not ANSI)

Contributors

  • KaptainWutax : Core part of the map system and libs setup
  • Neil : libs enrichment + utilities in Minemap + rich icons
  • Uniquepotatoes : Flat icons design
  • Speedrunning and monkeys discord ppl : input on feature for Minemap

Legal mentions

The main core part was done by KaptainWutax.

Any of the work done by Neil is released under MIT. However all materials which are not hand made will be released under the specific author license, this includes but not limit to some icons and the logo.

The visualizer is made by SnkSynthesis and released under MIT : https://github.com/SnkSynthesis/voxel-game

All the structures and features icons are released under CC-0 at https://github.com/hube12/mc_icons.

NOT OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG.