Get the latest release here - packed-v*.zip in the release contains all of the requirements listed below at their most up-to-date versions (at the time of release). Simply extract it and copy the contents in your game's installation folder.
If you want to install the mod outside of a release (not recommended), the build/ folder in the repo contains all of the mod-specific files that you can drag into your game's installation folder.
Configuration is done through redscript classes. See one example here. Variable & class names are limited to 1024 characters.
enum ModSetting {
OptionA = 0,
OptionB = 1,
OptionC = 2
}
class ModSettings {
@runtimeProperty("ModSettings.mod", "Mod")
@runtimeProperty("ModSettings.displayName", "UI-ModSetting-Label")
@runtimeProperty("ModSettings.displayValues.OptionA", "UI-ModSetting-OptionA")
@runtimeProperty("ModSettings.displayValues.OptionB", "Fixed Option B")
public let setting: ModSetting = ModSetting.OptionA;
}This example will produce the following results for enum values:
| Enum Value | Display Value |
|---|---|
OptionA |
Localized text GetLocalizedText("UI-ModSetting-OptionA") |
OptionB |
Fixed text "Fixed Option B" |
OptionC |
Value name "OptionC" |
For the mod to work with REDmod deployments, the following mod is required:
Running tools/ModStngs.1sc on mod_settings_main.inkwidget will toggle between using a custom class (ModStngs replacing Settings in SettingsMainGameController and SettingsSelectorController*) so the file can be opened & edited in Wolvenkit. If you keep the file open in Wolvenkit, you won't need to convert back, and only run the script after you've saved it in Wolvenkit, before packing.
If you come across something that doesn't work quite right, or interferes with another mod, search for or create an issue! I have a lot of things on a private TODO list still, but can start to move things to Github issues.
Special thanks to @psiberx for Codeware Lib, InkPlayground Demo, and Redscript & CET examples on Discord, @WopsS for RED4ext, @jac3km4 for Redscript toolkit, @yamashi for CET, @rfuzzo & team (especially @seberoth!) for WolvenKit, and all of them for being helpful on Discord.