Skip to content

Mod Loader Options

Kai edited this page Jul 13, 2023 · 5 revisions

Mod Loader Options

For easy configuration of the Mod Loader, you can use the options resource. Navigate to res://addons/mod_loader/options and double-click options.tres to open the resource editor.

Open resource editor, displaying the default configuration

Available Options

Option Name Description
enable_mods Enables or disables loading of mods.
log_level Sets the verbosity level for logs.
locked_mods List of mods that cannot be disabled or enabled in a user profile.
disabled_mods List of mods that will not be loaded on game restart.
allow_modloader_autoloads_anywhere If set to true, the ModLoaderStore and ModLoader Autoloads do not have to be the first Autoloads. Note: The ModLoaderStore Autoload still needs to be placed before the ModLoader Autoload.
steam_workshop_enabled If set to true, ModLoader will load mod ZIPs from the Steam workshop directory instead of the default location (res://mods).
override_path_to_mods Overrides the path from which mods are loaded. The default value if unspecified is "res://mods".
override_path_to_configs Overrides the path from which mod configurations are loaded. The default value if unspecified is "res://configs".
override_path_to_workshop Overrides the path to the Steam workshop directory. Can be used in the editor to load mods from your Steam workshop directory.
ignore_deprecated_errors If set to true, using deprecated functions will trigger a warning instead of a fatal error.
ignored_mod_names_in_log List of mods whose messages should be ignored in the log.

Feature Override Options (Feature Flags)

Introduced in v6.2.0
🛠TODO🛠

Profiles

You can find predefined option profiles in res://addons/mod_loader/options/profiles. These resource files can be dragged and dropped into the value field of a specific feature flag entry.

Screenshot of the File Dialog showing the available predefined option profiles Animation showing the drag and drop process

You can create your own option profiles by saving a ModLoaderOptionsProfile resource. One way to do this is to duplicate one of the existing profiles:

  • Right-click -> Duplicate...
    Screenshot of the duplicate context action
  • Give it a new name
    Screenshot of the file rename dialog
  • Now you can edit it to your liking by double-clicking it in the file dialog
    Screenshot of the resource editor
  • Use it as shown above.
Clone this wiki locally