7 Web UI Parameters

mikeprimm edited this page 2015-02-26 20:56:30 -06:00

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/

then, launching the site with the world named 'fred' selected, and with the map 'surface' being shown, would be formatted as:

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:

• 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).

• nopanel - if defined and set to 'true', the sidebar menu on the map will be removed

• 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).

• nogui - if defined and set to 'true', the web UI will disable ALL controls, panels and the like, just presenting the map layer itself.

• nocompass - if defined and set to 'true', the compass rose on the UI will be hidden (v2.2-alpha-1)

Contents

• Home
• Features
• Addons
• Resources
• Credits
• FAQ

Setup

• Base Plugin Settings
  • Installation
  • Configuration.txt
  • Permissions
  • Commands
• Web Setup
  • Internal Webserver
  • External Webserver Basics
  • External Webserver With MySQL/SQLite
  • Web ui login support and permissions
  • Web UI Parameters
• Storage Setup
  • File System Storage
  • MySQL/MariaDB Storage
  • PostgreSQL Storage
  • SQLite Storage
  • AWS S3 Storage
• HD Map Configuration
• World and template settings
• Guides
  • Boosting areas on Dynmap
  • Example configurations and demo website
  • Earthmc maps
  • limiting render area
  • Using /dmap
  • Using Markers
  • Dynmap on Oracle Cloud Instance
  • Dynmap and Cloudflare reverse proxy
  • Use-dynmap-via-Pterodactyl

Advanced Configuration

• Advanced Map Configuration
  • Full list of predefined perspectives
  • Defining Custom Lightings
  • Defining Custom Perspectives
  • Defining Custom Shaders
  • Color Schemes
• Component Configuration
• Configuration of worlds
• Exporting World Data in Wavefront OBJ Format
• External Webserver Advanced
  • External Webserver on hosting providers
    • Xenon Hosting Service
  • External Webserver on Linux
    • Apache httpd on Arch Linux
    • Apache2 on Debian
    • Lighttpd on Arch Linux
    • Lighttpd and SQLite on DietPi
    • Nginx
    • Nginx on CentOS 6.X
  • External Webserver on Windows
    • IIS
    • IIS Advanced

Mod Support

• Support for Minecraft Servers other than CraftBukkit
• Support for MinecraftForge based mods
• Support for Tekkit
• Custom Block Definitions
• Model Definition Files
• Texture Definition Files
• Defining a Block using a Custom Block Renderer
• Defining a Block using a Volumetric Model
• Defining a Cuboid Block
• Defining a Simple Block
• Defining Cuboid Models
• Defining Volumetric Models
• Special texture file types
• Using custom block renderers
• Incompatible mods

Developers

• How to compile dynmap
• Classes
  • BoxRenderer Class
  • FenceWallBlockRenderer Class
  • PaneRenderer Class
  • SkullRenderer Class
  • RedstoneWireRenderer Class
  • StairBlockRenderer Class
• Dynmap API