Upstream
/
dynmap
mirror of https://github.com/webbukkit/dynmap.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated World and template settings (markdown)

mikeprimm 2013-02-25 07:08:21 -08:00
parent 0f1df925b6
commit c01694631b
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
World-and-template-settings.md

@ -30,8 +30,12 @@ An example of a more comprehensive set of world settings are shown below:
z0: -1000
x1: 1000
z1: 1000
hiddenlimits:
- x0: 100
z0: 0
x1: 200
z1: 0
hidestyle: stone
autogenerate-to-visibilitylimits: none
center:
x: 0
y: 64
@ -58,11 +62,11 @@ The available settings are defined as follows:
- _fullrenderlocations_ : if defined, this list of world coordinates (each consisting of an **x**, **y**, and **z** coordinate) defines a set of additional locations (beyond x=0, y=64, z=0, or the player's current location, if a **/dynmap fullrender** command is issued by an in-game player) to be used to seed a full-render. Logically, fullrender is implemented like a _flood fill_ in a paint program - if a map has gaps in its areas of defined chunks, such as can happen if maps are explored via teleporting or portals, a fullrender seeded from one point may not reach all the patches of the world that have been generated: adding example locations within the other patches to the _fullrenderlocations_ list will cause those patches to be rendered, as well.
- _visibilitylimits_ : if defined, this list of rectangles can be used to restrict the area of the world to be rendered: areas outside of these rectangles will not be rendered with accurate map data, but instead some form of filler will be used (depending on the _hidestyle_ setting, below). If the list is empty (the default), no limits are implemented, and maps will be rendered to the edge of the generated chunks for the world. Each rectangle consists of two coordinate pairs - **x0**, **z0**, and **x1**, **z1**.
- _visibilitylimits_ : if defined, this list of rectangles can be used to restrict the area of the world to be rendered: areas outside of these rectangles will not be rendered with accurate map data, but instead some form of filler will be used (depending on the _hidestyle_ setting, below). If the list is empty (the default), no limits are implemented, and maps will be rendered to the edge of the generated chunks for the world. Each rectangle consists of two coordinate pairs - **x0**, **z0**, and **x1**, **z1**. As of 1.5-alpha-3, circular areas can also be defined, by providing an **x**, **z** value for the center and a **r** value for the radius, in blocks.
- _hidestyle_ : If the _visibilitylimits_ setting has restricted the visible areas of a world, the _hidestyle_ setting is used to control how the chunks of map data being hidden are presented. 3 settings are supported: **stone**, which causes a stone plain to fill the hidden areas; **ocean**, which causes a deep ocean to fill the hidden areas; or **air**, which causes the hidden area to be empty (like the edge of the generated portion of the world map). The default value is **stone**.
- _hiddenlimits_ : if defined, this list of rectangles that are the opposite of 'visibilitylimits' - they define specific areas of the world to be hidden (rendered based on the _hidestyle_ setting, below). If both 'visibilitylimits' and 'hiddenlimits' are defined, the 'visibilitylimits' are applied first (determining which areas are visible), and then the 'hiddenlimits' are used to further restrict that. Each rectangle consists of two coordinate pairs - **x0**, **z0**, and **x1**, **z1**. As of 1.5-alpha-3, circular areas can also be defined, by providing an **x**, **z** value for the center and a **r** value for the radius, in blocks.
- _autogenerate-to-visibilitylimits_ : If the _visbilitylimits_ setting has restricted the visible area of the world, this setting can be used to cause Dynmap to fill in the ungenerated portions of the map within the visible areas. The settings include **none** (do nothing - the default), **map-only** (generate the data needed to draw the map, but don't cause the chunks to be permanently generated), or **permanent** (generate and save the chunks for any ungenerated portion of the world).
- _hidestyle_ : If the _visibilitylimits_ and/or _hiddenlimits_ settings have restricted the visible areas of a world, the _hidestyle_ setting is used to control how the chunks of map data being hidden are presented. 3 settings are supported: **stone**, which causes a stone plain to fill the hidden areas; **ocean**, which causes a deep ocean to fill the hidden areas; or **air**, which causes the hidden area to be empty (like the edge of the generated portion of the world map). The default value is **stone**.
- _center_ : If defined, this provides the default center-of-focus for the view of the maps of this world. The coordinate includes the **x**, **y** and **z** coordinate of the center point, in world coordinates. If not defined, the center defaults to the spawn point for the given world.