3. Exporting your HUD - SuedOnAIM/RF_CustomHUD_Edits GitHub Wiki

Basics of Exporting Mutators

All mutators in Ravenfield are exported by a "Mutator Content Mod" prefab.

Make an empty game object with a Mutator Content Mod component, then turn it into a prefab by dragging it into your project files window. It is the same process as turning your HUD into a prefab.

The "mutator prefab" should be set to your HUD mod's prefab. image

Configuration Settings

Depending on what canvases you use, you will need to set up your configurations appropriately.

  • Label: adds text to your mutator configuration.
  • Integer: lets users input a whole number to affect a script.
  • Float: lets users input a number with decimal points to affect a script.
  • Range: adds a slider with modder defined minimum and maximum number.
  • String: lets users type words/letters to affect a script. Can be used for custom keybinds.
  • Bool: lets users toggle on and off a feature.
  • Dropdown: lets users select between different effects in a menu.

Each option will have an Id, Display Name, and Order Priority.

  • Id is how the script is able to read the configuration setting.
  • Display Name is the setting's name when players open the configuration menu.
  • Order Priority sorts the configuration settings. Lower numbers, including negative numbers, show higher on the settings menu. Bigger numbers show at the bottom of the settings menu.

You need to check the "Mutator Configuration" section of each canvas to know what id you will need for your HUD elements.

Exporting the HUD

To export your mod, select your mutator content prefab in the project window. Then press Control + E to export. Or go to Ravenfield Tools and Export Content Mod.
image