Game settings

load.game_settings() returns the server’s GameSettings: the difficulty and gameplay values of its configuration (gameSettings in enshrouded_server.json) or of the host’s world menu, read typed and changed while the world runs. It is Copy; get it during init and move it into handlers, tasks and actions.

use enshwick::actions::{Action, Arg, Outcome, Value};

fn init(load: &mut enshwick::Load<'_>) -> Result<(), enshwick::Off> {
    let settings = load.game_settings()?;
    let actions = load.actions(enshwick::i18n::Texts::default())?;
    let durability = Action::new("durability", "Item wear").admins().arg(Arg::toggle("On"));
    actions.add(durability, move |request| {
        let [Value::Toggle(on)] = request.args else {
            return Outcome::refused("On or off");
        };
        match settings.change(|s| s.enable_durability = *on) {
            Ok(_) => Outcome::done(format!("Durability {}", if *on { "on" } else { "off" })),
            Err(why) => Outcome::refused(format!("Unchanged: {why}")),
        }
    })
}

Reading

read() returns the settings in force as a Settings and the GameSettingsPreset they came from, or None off the game thread and while no world runs. Settings has a field for each of the game’s values: factors (1 is the game’s normal), switches, the day and night lengths and hunger’s time as Durations, and enums for the choices such as WeatherFrequency or TombstoneMode. An enum value this API does not name reads as Other(byte) and is written back as it was.

Changing

change(|s| ...) lets a closure edit the settings in force and applies them as the game’s admin command does: the server’s systems read them from the next step, every client gets them, and the preset becomes GameSettingsPreset::Custom. It returns the settings now in force, or a WorldError: Refused for a negative or not finite factor or a day or night length of zero, WrongThread off the game thread, Missing while no world runs.

Most values act at once. Some act on what comes next: enemy health, damage and stamina on enemies spawned after the change, food buffs on food eaten after it, the tombstone mode on the next death, the weather frequency on the next change of weather. A new day or night length keeps the clock’s hour and only changes its pace (time of day).

A change lasts until the server stops, and the configuration’s values return with the next start, unless the game saves its configuration first. A dedicated server writes gameSettings back to enshrouded_server.json whenever its configuration changes, such as after a ban, an unban or an admin’s settings change, and a change made here may then reach the file. keep(|s| ...) (minor 57) changes the settings the same way and keeps the fields whose value it changed with the running world: the loader applies them again each time that world loads, by the end of its first step, over what the configuration says. The loader keeps them by field name in mod-data/enshwick/worlds/<key>/game-settings.toml. forget_kept() forgets every kept field of the world, any mod’s, and puts back the values the world loaded with.

use enshwick::actions::{Action, Outcome};

fn init(load: &mut enshwick::Load<'_>) -> Result<(), enshwick::Off> {
    let settings = load.game_settings()?;
    let actions = load.actions(enshwick::i18n::Texts::default())?;
    let lush = Action::new("lush", "Plants grow twice as fast in this world").admins();
    actions.add(lush, move |_request| match settings.keep(|s| s.plant_growth_speed_factor = 2.0) {
        Ok(_) => Outcome::done("Kept for this world"),
        Err(why) => Outcome::refused(format!("Unchanged: {why}")),
    })
}

Several mods changing settings compose as their changes do: each change or keep edits the values in force, so mods that touch different values never meet, and the last change to one value wins; kept fields add up the same way.

Every call works on the server’s game thread, from a game event, a scheduler task or an action; on a client, while it hosts a game.