Running Roller from the command line

Roller should be run from the command line or from a Windows batch file.

Usage: roller.exe WRPFILE [options]

Replacing objects and textures:
    -F, --replace-forests A,B,C      Replace OFP forest block objects with
                                     individual trees and bushes, according to
                                     comma-separated list of YAML files (occurs
                                     after object replacement)

    -o, --replace-objects A,B,C      Replace objects according to
                                     comma-separated list of YAML files (occurs
                                     before forest replacement)

    -t, --replace-textures A,B,C     Replace textures according to
                                     comma-separated list of YAML files

Altering the terrain:
    -c, --terrain-cell-size N        Set new size of terrain cells (metres).
                                     This must give a legal grid size of 16x16
                                     to 4096x4096 cells (e.g. for an island
                                     imported from OFP, which has 50m cells,
                                     you could resize to 800, 400, 200, 100,
                                     25, 12.5, 6.25 or 3.125).

    -b, --terrain-bumpiness N        Maximum amount of vertical distortion of
                                     new grid points added by terrain-cell-size
                                     (metres). Applied after terrain cell
                                     resizing, but before other changes.

    -r, --raise-sea-level N          Move sea level up by this distance (move
                                     sea level down if negative). Done before
                                     edge-height is set.

    -e, --edge-height N              Sets the height of all terrain points
                                     around the edge to a specific value. This
                                     is applied after cell, bumpiness and
                                     sea-level changes.

Generating images:
    -m, --satellite-mask [FILE]      Export a satellite mask PNG image (FILE
                                     defaults to 'WRPFILE_mask.png')

    -C, --satellite-cell-size N      Size of satellite cells, i.e. pixels, in
                                     metres (defaults to 2m if this option is
                                     omitted')

Exporting files:
    -O, --objects [FILE]             Export BIS objects file (FILE defaults to
                                     'WRPFILE_objects.txt')

    -u, --unique-objects [FILE]      Export a list of objects used in the WRP
                                     (FILE defaults to
                                     'WRPFILE_unique_objects.txt')

    -w, --wrp [FILE]                 Export WRP file in 8WVR format, regardless
                                     of which format it was imported as (FILE
                                     defaults to 'WRPFILE_export.wrp')

    -x, --xyz [FILE]                 Export XYZ file (FILE defaults to
                                     'WRPFILE.xyz')

Common options:
    -p, --show-progress              Show the graphical progress bar (which
                                     will slow down all import, export and
                                     processing slightly).

    -f, --force-overwrite            Forces overwriting of existing output
                                     files (defaults to requesting user
                                     confirmation of overwrites)

    -?, --help                       Display this message

If running from sources, rather than from the executable, the parameters are exactly the same, but the way of calling the application is slightly different.

Usage: ruby roller.rb WRPFILE [options]

Key

Note that all file-names do not require an extension if they use the correct extension. Thus, replace_frogs is equivalent to replace_frogs.yaml if a YAML file is expected.

Back to the overview (home)