Skip to content

Latest commit

 

History

History
145 lines (109 loc) · 7.77 KB

YML_CONFIG.md

File metadata and controls

145 lines (109 loc) · 7.77 KB
Raw

YAML Config Documentation

This documentation contains a guide for making custom map & projection configuration files.

All configuration files' file extensions must be .yml.

If you're getting the YML syntax error, try fixing it in YAML Validator site

If you don't know how to make one, ask for support on our Discord server.

Tile map service (TMS) configuration

TMS files contain map services that will be displayed as an in-game hologram when selected.

The config directory is .../.minecraft/config/bteterrarenderer/maps/. Put your custom TMS config files there to see it in Minecraft.

The file name could be anything except default.yml.

Object properties are listed in the structure table.

example_maps.yml

See default_maps.yml for more examples

categories:
   # Map category.
   Global:
      # Map ID. It should be unique in its category and its file.
      # FYI: The mod automatically converts the map ID into something like "<category>.<id>".
      # So this ID is converted into "Global.osm"
      osm:
         name: OpenStreetMap
         tile_url: https://{random:a,b,c}.tile.openstreetmap.org/{z}/{x}/{y}.png
         projection: webmercator
         max_thread: 2
      # ...
   # ...

TMS object structure

Key Value Type Required? [Default] Description
name string Y Displayed Name. It supports color codes.
tile_url string Y Tile URL.
See URL parameters for its parameters
projection string Y Projection name.
See projection configuration for more info
max_thread int N [2] Maximum amount of threads to load map images
default_zoom int N [18] Default zoom value
invert_zoom boolean N [false] Zoom system is inverted when true.
Useful when lower zoom value means higher resolution
flip_vert boolean N [false] *Flip tiles vertically when true.
invert_lat boolean N [false] *Latitude is inverted when true. It will also flip tiles vertically.

* Tiles won't be "flipped" when both flip_vert and invert_lat are set to true

URL parameters

URL parameter Description
{x} X-axis parameter.
{y} Y-axis parameter.
{z} Absolute zoom parameter = (default_zoom) + (zoom slider value)
{u} Map Tile Quad key
{random:a,b,c,...} Picks string randomly from the given list; in this case a, b, c

Tile projection configuration

Some map providers will use projections other than the standard webmercator projection in order to reduce the amount of distortion happening in their country/region when using it.

You can use non-standard projections for those map services by making custom projection config files.

Given the coordinate system (such as epsg) and the tile matrix, the mod will calculate the tile position and display tile images accordingly.

The config directory is at .../.minecraft/config/bteterrarenderer/projections/. You can put your projection files there to add custom tile projections.

Default projections

Projection name CRS name Description
webmercator EPSG:3857
EPSG:900913
...		 Web mercator projection.
The most common coordinate system used for map services
worldmercator EPSG:3395 World mercator projection.
Used in Yandex.Maps
kakaoprojection EPSG:5181 Used for Korean map services, such as Kakao Map

example_projections.yml

See default_projections.yml for more examples

tile_projections:
   # Projection name.
   # This is global across every projection file, so beware of name clashes.
   webmercator:
      # The coordinate system object
      projection:
         proj4:
            name: 'EPSG:3857'
            param: '+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 ...'

      # It also supports Terraplusplus' projection objects
      # projection: {
      #     "scale": {
      #         "delegate": {
      #             "flip_vertical": {
      #                 "delegate": {
      #                     "bte_conformal_dymaxion": {}
      #                 }
      #             }
      #         },
      #         "x": 7318261.522857145,
      #         "y": 7318261.522857145
      #     }
      # }
            
      # Tile matrix. Key numbers mean the absolute zoom level.
      tile_matrices:
         0: { "origin": [ -30000.0, -60000.0 ], "size": [ 524288.0, -524288.0 ] }
         1: { "origin": [ -30000.0, -60000.0 ], "size": [ 262144.0, -262144.0 ] }
         2: { "origin": [ -30000.0, -60000.0 ], "size": [ 131072.0, -131072.0 ] }
         # ...

Projection object structure

Key Value Type Required? Description
projection CoordinateSystem Y Coordinate system object.
Tile matrix Map<int, TileMatrixRow> Y Tile matrix.

CoordinateSystem

The structure is equal to Terraplusplus' projection JSON structure but with the proj4 projection.

The table below is for the proj4 projection object. (See epsg.io for PROJ.4 information)

Key Value Type Required? Description
name string Y Coordinate system name
param string Y PROJ.4 parameters. Visit epsg.io for the parameters

TileMatrixRow

Key Value Type Required? Description
origin int[2] Y The coordinate at which the 0,0 tile is.
size int[2] Y Size of a single tile image.