Home

WurmMapGen

Installation

• Download the latest release
• Extract the downloaded archive and place it in your server 'mods' folder
• Adjust the settings in the properties file

Running the map generator

To start the application, just run the jar: java -jar WurmMapGen.jar.

Note: if you have a large map, it is advisable to limit Java memory usage. Example: java -Xmx5G -jar WurmMapGen.jar.

Custom properties file

By default, WurmMapGen will look for a WurmMapGen.properties file in the working directory. If you want to use another file, for example if you have multiple server configurations, you can add a CLI parameter: java -jar WurmMapGen.jar -c yourfile.properties.

Custom template

If you want to use a different template, you can specify the template directory with a CLI parameter: java -jar WurmMapGen.jar -t ./your-template-directory.

Verbose logging

To enable verbose logging (in order to track down bugs, or if you just want some more detailed logging), use the CLI parameter: java -jar WurmMapGen.jar -v.

Serving the interactive map files

To view the map, serve the output files from a webserver like Apache. PHP support on this webserver is not necessary, unless you enable realtime markers (see configuration). Opening the index.html file in your file browser may not work across all browsers due to implementation differences.

For a fast, secure and lightweight web server, I recommend Caddy.