Skip to content

Configuration

Wouter edited this page Jan 3, 2018 · 5 revisions

In the WurmMapGen.properties file you'll find a number of configuration options you can change to adjust the look and the features of the map.

Information

Basic information about your server, mostly for display purposes.

serverName

The name of your server, e.g. World of Wonders. In the default template, this will be shown in the title bar and in the left sidebar.

Server paths

Tells WurmMapGen where to look for the files it needs. Paths should always use forward slashes / instead of backslashes \ (even on Windows, where backslashes are normally used).

wurmMapLocation

Path to the directory where your map files are located, e.g. C:/Wurm Unlimited Dedicated Server/Creative. You can use a relative or an absolute path here, though it's usually best to stick to absolute paths, to avoid confusion.

saveLocation

Path to the output directory, where the generated files will be placed. This should generally be an empty directory, because the application will overwrite any existing files with the same name as the generated files.

Realtime settings

The interactive map can display semi-realtime location markers for players, by using WurmWebRMI. When enabled, it will update the player positions on the map every 30-60 seconds. This is not entirely realtime to prevent putting too much stress on the server.

enableRealtimeMarkers

Set to true if you want to enable realtime player markers on the map.

rmiHost

The host of the WurmWebRMI. Usually localhost.

rmiPort

The port of the WurmWebRMI. Default is 8080 but change this if you edited the WurmWebRMI configuration.

Map display settings

These options control the look of the map.

markerType

This sets the marker types to be used on the map. There are three possible values:

  • 1: classic markers, the same as in v1. Deed marker icons show the first letter of the deed name.
  • 2: new markers (default value starting with v2.1.0). These markers use slightly different colours, and deed marker icons are based on deed size. Used on the World of Wonders map.
  • 3: labels. Instead of using the typical markers, this map uses text labels with the deed name for deeds, and smaller icons for other locations.

Comparison of marker types

Map layers

Choose which layers to load and display on the map. When viewing the map, users can enable or disable layers as they like, but they are limited to the layers enabled in these settings.

showPlayers

Loads and displays the players on the map. Only works if realtime markers are enabled.

showDeeds

Loads and displays deeds on the map. Includes deed borders and basic deed information.

showGuardTowers

Loads and displays guard towers on the map, including their area borders.

Includes kingdom towers from the kingdom items mod.

showStructures

Loads and displays structures (buildings) on the map.

showPortals

Loads and displays portals on the map.

Includes portals from the new portals mod.

Map generation settings

These settings give some control in how the map tiles are generated.

mapGeneratorThreads

The number of threads to use for map generation. Should be a number between 1 and the number of cores on your machine. Threads are used to process more data simultaneously. A higher number of threads means the application will put more strain on your CPU, but it will complete faster. Lower numbers go easier on your machine but it will take longer to complete.

mapTileSize

The size of a map tile as it is loaded in the browser. This should always be a power of 2 (64, 128, 256, 512, 1024, ...) because that is how the Wurm maps work. Smaller tiles mean more files which take longer to generate, but use a bit less memory (though the different is not that big). Larger tiles mean less files.

It is best to keep this between 128 and 512. A tile size smaller than 128 will cause many browsers to choke because of the number of tiles required to fill the screen.

mapGenerateShading

If this is enabled, the map tiles will be shaded based on their elevation. This gives a somewhat 'pseudo-3d' look to the map. Disable for a more flat 'top-down' look.

mapShadingModifier

This modifier lets you adjust how "hard" the shadows and lights on the map will be, if shading is enabled. This can be useful if you have a very flat landscape, to make the elevation a bit more noticeable. A lower number mean less shadows, higher means more shadows. The amount of light or shadow will be multiplied by this number, so for the best results keep this between 0.8 - 1.2 (if you want the map completely flat, it's better to just turn off mapGenerateShading instead).

Comparison of shading modifier values

mapShadePaths

Also generates shading on paved tiles. Disable this to display all paved tiles in the same colour, independent of elevation.

mapGenerateWater

Displays water on tiles under the water level.

mapGenerateBridges

Loads and displays bridges on the map.