Skip to content

A dynamic world map within Minecraft (mainly based on OpenStreetMap)

License

Notifications You must be signed in to change notification settings

SmylerMC/terramap

Repository files navigation

Terramap

A dynamic world map within Minecraft

Build status Discord link CF Downloads Modrinth Downloads

Terramap is an addon to the Terraplusplus Minecraft mod. It renders real world maps inside of the game with extended features. It is still in beta and lacks intended features.

Useful links:

Main Features:

  • Display world maps directly in Minecraft, in a dedicated screen and as a minimal.
  • Display a compass indicating the real geographic north directly on the in game HUD (rather than the Minecraft north)
  • Multi layer maps: maps can display multiple sources on top of each other. Layer types include online raster tiled map, Minecraft regions and Terraplusplus generation preview.
  • Easy world-wide teleportation through the maps' right-click menu or CTRL+click.
  • Display player positions on the map, server or network-wide
  • Quick access to technical information about a place, including distortion or region coordinates.
  • Quick access to other map services. The default provider is OpenStreetMap.
  • Configurable map providers, with server to client config synchronization.

Planned features

  • Vector maps
  • Geocoding
  • Support for more modding framework (Forge, Fabric, Bukkit)
  • Support for more modern Minecraft versions

Installation

Make sure you have Minecraft Forge 1.12.2 installed, as well as the necessary mod dependencies: Terraplusplus, CubicChunks, and CubicWorldGen. Installing a Forge mod is as simple as dropping the mod file in the mods folder in your Minecraft installation directory (I will not go into the details here, there are plenty of great guides online). Alternatively, Terramap comes included in the Build The Earth modpack installer.

Screenshots

Terramap on a solo world, with the vanilla osm style: terramap screenshot solo

Custom map styles on BTE-France: terramap screenshot styles

How to use it:

In game, press m to open the full-screen map (by default, but it can be changed in the config) Drag it, zoom in and out, and explore the world just like with any other digital map. Right-click somwhere to get a menu with various useful tools (see the screenshots). Additionally, you can: press p to toggle debug mod, press control to enable quick tp mode, change the map style in the map style menu, change entity display preferences, follow an entity or player by double clicking it, configure the minimap in the mod's config, add your own map styles, and more... Checkout the wiki for more technical information.

Terramap will work best if it is installed both on the server and the client. This is because it needs to synchronize the map projection used by the server to the client. It is still usable if installed only on the client, as long as you know and take the time to manually set the projection used.

Contributing to the project:

In case you want to contribute, please make sure you join the Discord. You will get a contributor role there.

Code

Future updates are already planned ahead, so please contact me before contributing code so we can discuss the changes you want to make first. In any case, please fork this repository and create a pull request from your fork. You can clone your fork to your computer and work from your IDE there. Make sure you follow the Minecraft Forge instructions to setup the development environment.

Translation

Contribution for translations are welcomed at any time. Please note however that the mod will still change quite a lot, and your translation will probably need to be updated to reflect theese changes. You don't have to stay available to update it personally, but your work may end up being modified by someone else if needs to be. If you are not comfortable using Github you can send me your translation file on the Discord or ask me anything there.