Configuration
OpenMineMap has a large number of configuration options, which are all explained (or soon will be) as in depth as possible here. All options listed here can be found and modified using the Configuration Button, which is found in the Fullscreen Map. All configuration settings are stored in the config.txt file
IMPORTANT: To save any changes made in the config screen, you will need to click the checkmark button on the right side of the config screen. If you want to exit without saving your changes, you can use the x button or the escape key.
Configuring the Hud is the first option in the menu. It allows you to change the size and position of OpenMineMap's Hud elements, namely the map and strip compass.
The map can be resized in all 4 directions, and can be repositioned, all by clicking and dragging. The minimun width and height for the Hud Map is 20. There are no restrictions on where it can be placed.
The compass can only be resized laterally, but can be repositioned to anywhere. The minimum width for the compass is 20.
These options are found at the center of the screen. Similar to the main configuration screen, the checkmark button saves your configuration before exiting, while the x button doesn't. There is also the reset button, which will set the positions and dimensions of both Hud elements to their defaults.
The default zoom sizes for OpenStreetMap tiles range from 0-18, with 0 being the whole world and 18 being the smallest tile available. This is the range that is usually permitted in OpenMineMap. Enabling Artifical Zoom will cause the smallest tile size to be scaled up in order to zoom in more. This results in a zoom range of 0-24, beyond what OpenStreetMap usually provides.
This is a feature that lets you quickly look in a specific direction using a keybind. This can be especially useful if you line it up with the building or city block you are building. This is based off of a Minecraft angle, not a Geographic one (meaing a value of "0" degrees will mean Minecraft North). When setting a snap angle, your current angle will automatically be entered, but it can be manually entered as well. When set, purple indicators for the snap angle will appear on the Hud Compass:
The Hud compass with snap angle indicators
When the Snap angle key is pressed, your player character will snap to the nearest angle laterally to the direction you are currently facing. There is not a default key bound for this, you will need to set it manually.
Depending on what world/server you are on, you may not have permissions for /tp or /tpll. Additonally, the tpll command just doesn't exist in singleplayer. To maintain functionality on the Fullscreen Map, this option allows you to change what command the Teleport Here of the Right Click Menu feature uses.
Enabling this option will invert the scrolling of your mouse for the Configuration Screen and Fullscreen Map's Zooming.
Sets the zoom strength of the fullscreen map, which changes how much you will zoom in for each scroll input of the mouse. This does not affect the zoom strength of the zoom in/out buttons or keybinds; they are hard-coded to be 1.
For overlays that determine whether or not certain elements appear, the following display levels apply:
- None: No rendering of that element
- Self: Only your player character is renderer
- Local: Only local players are rendered
If I ever add a server integration to this mod, an "All" display level will also be added
Change the visibility of players on your map.
Change the visibility of direction indicators on your map. If the permission level for direction indicators is higher than the one for players, a special indicator will be used.
A "normal" direction indicator (left) and a "special" direction indicator (right)
If enabled, you can view the name of a player on the map by hovering over them with your mouse cursor.
If you are trying to locate a player with OpenMineMap, it can be hard to tell where exactly they are vertically. Altitude Shading helps with this by shading other players based on their height in relation to you. Players higher than you are lightened and players lower than you are darkened.
The exact values are as follows:
- Differences of less then +/- 16 have no change
- Differences of +/- 16 to +/- 80 range from 0% brightness change to ~50% (120/255)
- Differences of more then +/- 80 change are capped at ~50%
Example of Altitude Shading
This information primarily applies to OMM versions 1.4.0+
The tile source defines what tile provider you would like to load tiles from. By default, they are loaded directly from the base OpenStreetMap, but different providers can provide different map styles. OpenMineMap defines two other tile providers: Humanitarian and CyclOSM.
To add a custom tile source, you will need to modify the tileSources.json, found within the openminemap folder.
Per OpenStreetMap's Attribution Guidelines, any applications that use OSM's data must display attribution that follows certain guidelines, and this extends to also attributing any Tile Provider that is used. Because OpenMineMap cannot include this information for every possible source, this must be defined by the user. When adding a custom Tile Source, you are responsible for adding the applicable attribution information.
OpenTopoMap will be used here as an example addition. A full list of tile providers can be found here.
See the Verification section for a complete example
Append the following to tileSources.json:
. . .
"https://www.openstreetmap.fr"
]
},
{
"name": "",
"source_url": "",
"attribution": "",
"attribution_links": [
""
]
}
]
}
Each field listed here is required and will need to be filled out properly for OpenMineMap to load tiles.
This is the only field with no specific requirements. It will be used in-game and in the config.txt to tell your Tile source apart from the others, so make sure it's something identifiable. I'll use OpenTopoMap for this example.
This is the web url that tiles will be provided from. All urls entered here must have a {z}, {x}, and {y} field, which define the zoom, x, and y parameters of any given tile request. Most urls also have an {s} field, which defines a subdomain.
OpenStreetMap's tile provider list provides this field for us. In the case of OpenTopoMap, the source url is https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png.
This field defines the text that will be shown on the bottom right of the Fullscreen map. It should list attribution information for the source provider you are using, as well as have text that links to the attributors. The easiest way to determine what this should be is to go to the web map of the tile service provider, which will contain attribution information (usually in the bottom right corner):
Found on opentopomap.org
Here we can see that there are 2 things we need to include: STRM and of course OpenTopoMap. We will also need to include the "CC-BY-SA" license. Attribution for OpenStreetMap is automatically appended by the mod, so we don't need to worry about attributing them.
The specific formatting and order for this isn't too important, as long as it's clear what each thing is. I settled on this:
map data: STRM | style: OpenTopoMap (CC-BY-SA)
We will also need to tell OpenMineMap what text should be linkable. To do this, surround each string of linkable text with brackets, like so:
map data: {STRM} | style: {OpenTopoMap} ({CC-BY-SA})
This is a list of fields that define what the links in the attribution field will be. The links will be applied to the attribution field in the same order we put them here, meaning the order should be:
- STRM:
http://viewfinderpanoramas.org - OpenTopoMap:
https://opentopomap.org - CC-BY-SA:
https://creativecommons.org/licenses/by-sa/3.0
By the end of this whole process, your new tile source should look something like this:
. . .
{
"name": "OpenTopoMap",
"source_url": "https://{s}.tile.opentopomap.org/{z}/{x}/{y}.png",
"attribution": "map data: {STRM} | style: {OpenTopoMap} ({CC-BY-SA})",
"attribution_links": [
"http://viewfinderpanoramas.org",
"https://opentopomap.org",
"https://creativecommons.org/licenses/by-sa/3.0"
]
}
. . .
At this point, you can attempt to start OpenMineMap and see if your tile source loads successfully. OpenMineMap runs several tests to check for inconsistencies, and any that it detects will be sent as a chat message when you join a world. If any inconsistencies are detected, the tile source will not show up as a config option in the config menu. If OpenMineMap doesn't know what tile source to use, it will default to OpenStreetMap.
The errors that OpenMineMap will give are generally self-explanatory. The list of possible errors is as follows:
-
tileSources.json is formatted incorrectly.: Some error occurred because of invalid formatting with the file. This usually due to a quotation/bracket that is missing its pair. -
Blank TileUrl detected. This may be due to invalid file formatting.: This usually means that the placement of parameters is incorrect. -
At least one required field is blank.: Occurs if any of the four fields (name, source_url, attribution, attribution_links) is blank. -
Source Url is not a valid link.andAt least one Attribution Link is not a valid link.: Pattern verification is run for all links . If verification does not pass, this error will occurr. This may also indicate mismatched brackets. -
Bracket placement for Source Url is invalid.andBracket placement for Attribution is invalid.: Indicates an error when parsing the bracket fields. Brackets should always be in open and close pairs ({#}), and brackets should not contain other brackets. -
Mismatched number of links between Attribution Links list and Attribution string.: The number of bracket fields for links listed in the source_url must match the amount of links listed in attribution_links. -
Source Url is missing an X/Y/Zoom field.: The source_url must always contain these bracket fields so that OpenMineMap can properly request tiles from the tile source. Ensure that your x/y/z fields are contained within brackets.
Image of OpenTopoMap successfully loaded into OpenMineMap. Tiles load and attribution shows successfully