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

Created Web UI Parameters (markdown)

mikeprimm 2011-09-19 14:32:34 -07:00
parent fbaa1da161
commit 0500d4f594
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Web-UI-Parameters.md Normal file

@ -0,0 +1,28 @@
The URL used to launch the web user interface supports a number of parameters, which may be used to override the default view presented to the user. This can be used to launch the UI with a given world or map selected, a given zoom level selected, and/or have the map centered on a given set of world coordinates.
The parameters are provided as a sequence of attribute-value pairs, with each parameter formatted as follows:
__attribute-id__=__value__
The base URL must have a question-mark (?) before the first parameter, and each additional parameter must be separated from the previous one by an ampersand (&). So, if the default URL for the map web is:
http://mygreatserver:8123/map
then, launching the site with the world named 'fred' selected, and with the map 'surface' being shown, would be formatted as:
http://mygreatserver:8123/map?worldname=fred&mapname=surface
The parameters available are as follows:
* **worldname** - this specifies the name (not the title) of the world to be selected. If not provided, the first world defined will be shown (unless __defaultworld__ has been set in _configuration.txt_, in which case that world is shown).
* **mapname** - this specifies the name (not the title) of the map to be selected. If not provided, the first map for the selected world is shown (unless __defaultmap__ has been set in _configuration.txt_, in which case that map is shown).
* **zoom** - this specifies the zoom level to be selected (0 = highest zoom out). If not provided, a zoom level of zero is used (unless __defaultzoom__ has been set in the _configuration.txt_).
* **x** - this specifies the X coordinate (in the coordinate system of the world being shown) of the center point of the map view. If not specified, this defaults to the value of the _x_ attribute of the _center_ attribute of the selected world (typically 0).
* **y** - this specifies the Y coordinate (in the coordinate system of the world being shown) of the center point of the map view. If not specified, this defaults to the value of the _y_ attribute of the _center_ attribute of the selected world (typically 64).
* **z** - this specifies the Z coordinate (in the coordinate system of the world being shown) of the center point of the map view. If not specified, this defaults to the value of the _z_ attribute of the _center_ attribute of the selected world (typically 0).