WhyMap

WhyMap 2.0

WhyMap 2.0 Release is planned on early July. It'll have a brand new in-game world map and other requested features and bugfixes. Stay tuned and remember to update your mod when it's released!

See interactive web demo on: https://wefhy.github.io/whymap-demo/map.html

You can zoom in close enough to see the textures of blocks. It's old 0.8 version from September 2022 but should give you hint of what it feels like to browse the map in the browser.

High performance minecraft world map with web-based interface and infinite zoom. Your map will be presented at http://localhost:7542

Download the mod from:

Join discord for support:

How to use it?

• Install the mod and required dependencies (Fabric Language Kotlin and Fabric API)
• All keyboard shortcuts can be configured in minecraft keybind settings
• Y - toggle minimap
• M - configuration (requires Cloth Config)
• B - create new waypoint
• Open your browser at http://localhost:7542 to browse the map
• Zoom in to see block textures
• Click right mouse button on the map to see more options
• Click on the waypoint to center the map on it (after you add waypoints)
• You can search waypoints or coordinates

Actively supported versions:

• 1.20.3, 1.20.4

Other supported versions:

• 1.20, 1.20.1, 1.20.2
• 1.19, 1.19.1, 1.19.2, 1.19.3, 1.19.4
• 1.16.5

FAQ

How to use it?

• Browse your map on http://localhost:7542

How to add waypoints?

• You can import xaero's waypoints from file though browser
• Press B in game to create new waypoint
• Right-click on the map to create new waypoint

Is the mod uploading my world to the internet?

• No, the mod is not uploading your world to the internet. It's running a local web server on your computer.

Who can access my map?

• The map can only be accessed from your computer.
• If you change it in the settings, the map can also be available to other computers and phones on your local network.

So how does it work?

• The mod is using your browser to display files that are stored on your computer.
• The mod creates a local web server that shows the tiles to your computer.
• The mod is using Leaflet to display the map.
• Nothing goes online. All data is stored in WhyMap folder in your minecraft directory. You can freely delete it or move it to another computer.

Can I browse the map on my phone?

• In order to browse the map on your phone, you need to change the settings of web server from LOCALHOST_ONLY to EVERYWHERE
• Then you can browse the map on your phone by going to http://[YourComputerLocalIp]:7542 (assuming you're connected to the same wifi)

How is WhyMap better than other map mods?

• Incredibly detailed map that shows block textures when zoomed in.
• High performance and doesn't lag when zoomed out.
• Access your maps even when minecraft is not launched (coming soon).
• It's fully open source.
• You can browse the map on your phone.

Can I use it with Quilt?

• I only actively support Fabric, however it should work with Quilt.
• In order to run it with Quilt, you need to install Quilted Fabric API and Quilt Kotlin Libraries instead of Fabric API and Fabric Language Kotlin.

How big is the project?

• 
• 

Building from sources

First install yarn packages for frontend:

cd src-vue
yarn install
cd ..

To run the mod:

gradle runClient

To compile jar file:

gradle build

License

GPL-v3

Contributions

I DO NOT accept contributions to this repository at this moment. Pull requests will be rejected.

If you wish to help with frontend development, frontend repository is open for contributions (or even a complete rewrite because I'm bad at frontend coding)