Updated Web UI Parameters (markdown)

mikeprimm 2012-01-08 09:56:50 -08:00
parent b924d72fa1
commit 76d0cf82ce
1 changed files with 8 additions and 2 deletions

@ -6,11 +6,15 @@ The parameters are provided as a sequence of attribute-value pairs, with each pa
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
http://mygreatserver:8123/
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
http://mygreatserver:8123/?worldname=fred&mapname=surface
If you're using an external server, the same format applies - add '?' and the corresponding parameters, seperated by ampersands:
http://mycoolapacheserver.com/dynmap?worldname=fred&mapname=surface
The parameters available are as follows:
@ -31,3 +35,5 @@ The parameters available are as follows:
* **chatname** - if defined and set to a string, the web UI will pass this value as the suggested name of the sender for any chat messages. This will only be accepted by the internal web server if the 'trustclientname' setting has been set to true, in addition to the 'allowurlname' parameter for the 'chat' component. Supported on 0.28 and later.
* **playername** - if defined and set to a player's account name, the web UI will initialize following the position of the given player, if the are online when the UI starts, or come online sometime after.
* **hidechat** - if defined and set to 'true', the web UI will disable all chat input and output components (balloons, input fields, and chat box).