Updated HD Map Configuration (markdown)

mikeprimm 2011-08-06 13:44:57 -07:00
parent e0cb151f55
commit ade0be2f6e
1 changed files with 17 additions and 1 deletions

@ -1,4 +1,4 @@
With their introduction in v0.20, the HDMap map type provides a new, more flexible, and (arguably) more complex means of defining and customizing the maps a user can define for their server. Several details on how HDMaps are defined and structured are intended to offset the additional complexity - but it is important to understand the basic "theory of operations" behind an HDMap definition, in order to know what you need to do to get what you want out of your maps (and not have to work any harder than necessary to get it).
With their introduction in v0.20, the HDMap map type provides a new, more flexible, and (arguably) more complex means of defining and customizing the maps a user can make available on their server. Several details on how HDMaps are defined and structured are intended to offset the additional complexity - but it is important to understand the basic "theory of operations" behind an HDMap definition, in order to know what you need to do to get what you want out of your maps (and not have to work any harder than necessary to get it).
## The Basics: How to add an HDMap to templates or worlds
@ -111,3 +111,19 @@ For details on defining custom perspectives, shaders or lightings, see the follo
[[Defining Custom Lightings]]
Once a custom perspective, shader or lighting is defined, maps can use them by name, the same as any of the predefined configurations.
## Additional HDMap Settings
HDMaps support a number of additional, optional settings, that allow more control of how the map is presented and used by the user. These settings include:
- _title_ : this setting controls the presentation label on the web interface for the map.
- _icon_ : this setting allows control of the URI of the image file used for the map icon on the web interface. If not defined, the value used is **images/block_**_name_**.png**.
- _background_ : this setting provides a color value for the background on the map. Color values are formatted as typical for CSS styles: #rrggbb. If undefined, the background is black (#000000).
-_backgroundday_ : this setting provides a color value for the background of the map during daytime - it overrides the _background_ setting, if defined, when daytime maps are shown. Formatting is CSS style: #rrggbb. Only applicable to night-and-day type maps.
-_backgroundnight_ : this setting provides a color value for the background of the map during nighttime - it overrides the _background_ setting, if defined, when nighttime maps are shown. Formatting is CSS style: #rrggbb. Only applicable to night-and-day type maps.
-_mapzoomin_ : this setting controls the number of zoom-in steps offered for the map beyond the 'native' resolution of the map. These zoom levels stretch the map without showing more map data - the same pixels are shown larger (2x bigger for one step, 4x for two steps, 8x for three steps, etc). By default, the value is 2 (allowing 2 extra zoom ins, corresponding to 2x and 4x).