Rivermod help

Overview

This page provides help documentation for Rivermod's various features.

Editor configuration

Initial setup

When launching Rivermod for the first time, you will be prompted to set the directory where your copy of Riverworld is installed. Assuming the default installation options, this will typically be C:\Program Files (x86)\Cryo\RiverWorld. The game directory can be changed at any time later (see Changing the game directory.

Tip

See Installing Riverworld for help installing Riverworld on modern hardware.

Changing the game directory

You can change the directory Rivermod searches for game files at any time by completing the following steps:

1. From the menu bar, select Editor
2. Select Set Game Directory
3. Choose the new directory
4. Press Select Folder

Save game manager

By default, Rivermod will automatically backup your game saves every few seconds even while the game is running. Using the save game manager in Rivermod's main window, you can then assign these archived saves to any of the game's 10 save slots. You can also manually backup your saves, clear a save slot, or delete a save.

Manually sync save games

To manually sync your save games, complete the following steps:

1. In the main window, locate the Save Manager widget
2. Locate the *Saves column and press the sync button
3. Check the status message next to the sync button to confirm the sync was successful

Note

It is not typically necessary to manually sync saves. Rivermod will automatically sync your save games every few seconds by default.

Assigning a save to a slot

Complete the following steps to assign an archived save to one of the game's save slots:

1. In the main window, locate the Save Manager widget
2. Locate the *Saves column and find the save you wish to assign in it
3. Press the menu button (aka meatball button) for the save you wish to assign
4. Select the Assign to slot x option for desired slot

Note

It is perfectly safe to assign a save to an occupied slot. The save previously occupying the slot will be archived and can be reassigned to another slot later if desired.

Clearing a save slot

Complete the following steps to unassign a save from a save slot:

1. In the main window, locate the Save Manager widget
2. Locate the *Slots column and find the slot you wish to clear
3. Press the menu button (aka meatball button) for the slot you wish to clear
4. Select the Clear slot option

Note

Clearing a save slot is non-destructive. The save assigned to the slot will still be present in your saves list and can be reassigned to a slot later if desired.

Deleting a save game

Caution

Deleting a save will PERMANENTLY delete the save from both your game and Rivermod's backups. This cannot be undone.

Complete the following steps to permanently delete a save game:

1. In the main window, locate the Save Manager widget
2. Locate the save you wish to delete either from the Slots list or the Saves list
3. Press the menu button (aka meatball button) on the save you wish to delete
4. Press the Delete save button
5. In the confirmation dialog, press Delete to confirm

Map viewer

Rivermod provides a tool to view the terrain of any game level or save file. Due to current parsing limitations, you need to select which level's tileset the terrain should be viewed with.

Loading a map

To view a map, complete the following steps:

1. From the menu bar, select Tools
2. Select Map Viewer
3. In the map viewer window, locate the top selection box on the left
4. Choose the level script whose textures you want to render the terrain with
5. Locate the next selection box and choose the map (totalmap) or save file (map*.sav) you wish to view

Note

If a map's textures appear incorrect, try selecting a different level script.

Navigating in 3D

The viewer camera can be moved using the mouse and keyboard.

To move the camera, hold the right-mouse button and use the WSAD keys to move and the mouse to change direction. Holding left-shift while moving will increase the camera's speed.

Switching render modes

The map viewer provides three rendering modes: textured, grid, and wireframe.

To switch how a map is rendered, complete the following steps:

1. Locate the render mode selection box under the map selection box
2. In the render mode selection box, choose the desired rendering mode

Enabling/disabling terrain wrapping

Riverworld wraps the terrain of its maps horizontally and the map viewer mimics this behavior by default.

To enable or disable terrain wrapping, complete the following steps:

1. Locate the Wrap edges toggle under the render move selection box
2. Change the toggle position to enable or disable terrain wrapping

Enabling/disabling fog of war

When viewing a save file, the map viewer can optionally display the fog of war over the minimap.

To enable/disable the fog of war, complete the following steps:

1. Locate the Fog of War toggle over the minimap on the right side of the map viewer window
2. Change the toggle position to enable or disable the fog of war over the minimap

Note

The fog of war for an unmodified level file (totalmap) will always be completely filled.

Model viewer

Rivermod provides a tool to view most of the game's models.

Note

The models of characters, such as Burton, cannot be viewed at this time; however, models for character armor can be viewed.

Viewing a model

To view a model, complete the following steps:

1. From the menu bar, select Tools
2. Select Model Viewer
3. In the model viewer window, locate the top selection box on the left
4. Choose the model you wish to view
   • A rough translation of most model file names is provided in parenthesis

Note

Some models are very small or very off-center and may require you to adjust the camera to see them.

Selecting an element

Many Riverworld model files contain multiple variations of a model called an "element".

To change which element is displayed, complete the following steps:

1. Locate the element selection-box on the left under the model selection box
2. Choose the element you wish to view

Note

Not all models have more than one element. Models with multiple elements are often just the same model at different origin offsets.

Selecting objects to display

Most Riverworld models are comprised of multiple sub-objects.

To choose which sub-objects are displayed, complete the following steps:

1. Locate the object list under the element selection box
2. Use the vertical scroll bar to view the full list of objects
3. Select a single object to view only it or shift-click multiple objects to view them together

Adjusting the camera

The model viewer camera can be moved in and out for a better view of models.

To move the camera close, scroll up on the mouse-wheel. To move the camera back, scroll down on the mouse-wheel.

Switching render modes

The model viewer allows you to view models in three modes: textured, normals, and wireframe.

To change model rendering modes, complete the following steps:

1. Locate the rendering mode selection box under the model file selection box
2. Select the rendering mode you wish to use

Reviewing the model viewer log

The model viewer provides a list of all warnings and errors encountered while parsing a model file.

To view the model viewer log, complete the following steps:

1. Locate the log panel at the bottom of the model viewer window
2. Use the handle above the log panel to expand it (the handle may be difficult to see)
3. Use the Copy all button to copy all log entries to the clipboard

Sprite viewer

Rivermod provides a viewer for the game's .SPR files. These files are primarily used by the game as fonts.

Viewing a sprite sheet

To view a sprite sheet, complete the following steps:

1. From the menu bar, select Tools
2. Select Sprite Viewer
3. In the sprite viewer window, select the File menu option
4. Select Load sheet
5. Choose the .SPR file you wish to load (see the EDITOR or TABS directories)