File Structure

Summary

All files related to OpenMineMap are stored in a special subfolder of Minecraft's root directory, "openminemap". This includes tile images, as well as config files and other files used by OpenMineMap.

---

Tile Folders

• 1.4.0+

Tiles are stored in the folders /openminemap/<tile source>/<0-18> Each tile source has a separate folder for it's tiles. Tiles are stored indefinitely, and can only be removed via manual deletion from a file manager.

• 1.0.0 - 1.3.0

Tiles are stored in the folders /openminemap/<0-18>, corresponding to the zoom levels of OpenSteetMap tiles. Tiles are stored indefinitely, and can only be removed via manual deletion from a file manager. However, all tiles will be purged when the Tile Url is changed, in order to make way for the new, presumably different tiles.

---

Other Files

• config.txt

This file contains cofigurations related to OpenMineMap. This includes the options found in the Configuration menu, as well as saved map positions and developer parameters such as "DisableWebRequests"

Any options with a preceeding "§" are session parameters. They are saved to this file and read when OpenMineMap starts in order to restore where you were on the map; otherwise, things like your position on the Fullscreen Map and zoom levels would be reset every time you rejoined.

It's best not to modify this file directly. The code that reads it is admittedly quite fragile, and there isn't anything you would need to modify that couldn't be changed in other ways.

File Structure:

Parameter1 : value1
ParameterA : valueAB
OnceUponAParameter : valueX
...

_{If you really want to use any developer options, they can only be changed directly from this file (;}

• location.kml

This is the file that is used to open Google Earth Pro whenever the option to do so is selected in the Fullscreen Map's Right Click Menu. You can find more info here.

• rasters.json_1.8.0+

Defines custom rasters for OpenMineMap to load from. OpenStreetMap is used by default, but extra base and overlay rasters can be added here in-game via the raster menu.

When updating to 1.8.0+, this file will be generated from the existing tileSources.json file.

File Structure:

{
  "sources": [
    {
      "name": "Example Name",
      "source_url": "https://tile.map.example/{z}/{x}/{y}.png",
      "attribution": "Tiles style by {Example}, hosted by {Example}",
      "attribution_links": [
        "https://www.example.org",
        "https://www.exampletwo.com"
      ],
      "layerType": "base/overlay"
    }, ... {
      ...
    }
  ]
}

• tileSources.json_1.7.2-

Defines custom tile sources for OpenMineMap to load from. OpenStreetMap is used by default, but more can be added here. (More info on tile sources)

When updating to 1.8.0+, this file will be renamed to tileSources.json.old and no longer utilized. It is replaced by rasters.json.

File Structure:

{
  "sources": [
    {
      "name": "Example Name",
      "source_url": "https://tile.map.example/{z}/{x}/{y}.png",
      "attribution": "Tiles style by {Example}, hosted by {Example}",
      "attribution_links": [
        "https://www.example.org",
        "https://www.exampletwo.com"
      ]
    }, ... {
      ...
    }
  ]
}

• apiKeys.txt

Stores API keys for raster presets that require it.

• searchHistory.json

Stores the previous 50 location search queries and their results. Searches saved to history can then be accessed from the search bar.