Changelog

3.0.2 stable 2026-09-30

Built on l3i 1.1.0.

Changed

• l3i 1.1.0 comes from crates.io; the @dream/openmw-config module is unchanged.

3.0.1 stable 2026-09-29

The Luau bindings are an l3i extension with live views and typed rows, the loader reads config= chains exactly as OpenMW’s engine does, and the site is built with the DreamWeave Mod Template.

Breaking changes

• The luau feature makes the crate an l3i extension, openmw_config::luau::extension(), providing the module @dream/openmw-config, with live views over the loaded configuration and typed rows. create_lua_module, the mlua types and the standalone-lua feature are gone.
• Building with the luau feature needs l3i’s toolchain: clang, lld and cross-language thin LTO. Rust 1.92.
• The loader matches OpenMW’s engine: config= entries load depth first, each config= directory is read once, a config= directory without an openmw.cfg stays in the chain, the user config directory is created on load, replace= applies per config over the configs loaded before it, replace=config keeps the root and the config= entries still to load, replace=replace discards the replace= lines of earlier configs, replace= values match option names exactly, and resources=, user-data=, data-local= and encoding= are left alone by replace=.
• The crate’s internal macros are no longer exported.
• Built, released and documented with the DreamWeave Mod Template; the site replaces the rustdoc pages.

Added

• Typed game setting values and setting metadata, SettingValue exported so predicates can name what they are given, and the meta() and typed accessors every setting type has.
• The views declare their element types, so strict scripts read them directly; items are pushed by value.
• A Criterion benchmark for the Luau boundary.

Changed

• List positions are indexed, game settings iterate without cloning, settings are no longer formatted on load, and the lookup indexes hash with FxHash.
• l3i 1.0.0 comes from crates.io.

Fixed

• save_user, save_subconfig and Display keep replace= lines; list replacements and removals persist through replace= lines in the user config, and a parent’s entries stay in the parent’s file when the user config replaces a list.
• The injected resources/vfs data directory is no longer written back as a data= line on every save; the directories resources= and data-local= add stay in step with them.
• Windows and macOS fall back to the user config; the io::Error behind ConfigError::Io is reachable through source().
• add_archive_file returns CannotAddArchiveFile on a duplicate; replace=fallback-archive is read and written under the option name OpenMW uses.
• set_game_setting writes its comments as comment lines, and the comments and blank lines that end a config file survive the settings added after them.
• The setting indexes are rebuilt when singleton settings change and after data directories are injected; a parent’s relative data directory is written resolved when the user config copies it; a parent’s resources=, user-data=, data-local= or encoding= stays in place when the user sets one.
• The live-view generation counter advances without wrapping, so a stale row can never read as current again.

2.0.1 stable 2026-09-27

Changed

• Relicensed under MIT OR Apache-2.0.

Known issues

• save_user, save_subconfig and Display drop replace= lines, so a saved user config merges its parents’ entries back in on the next load. Fixed on the default branch.
• A config with resources= writes the injected resources/vfs directory back as a data= line, and each save and reload adds another copy. Fixed on the default branch.

2.0.0 stable 2026-09-26

The Lua bindings run on Luau.

Breaking changes

• The bindings build against mlua 0.12 and the lua feature no longer selects a Lua runtime: the host application picks one through its own mlua dependency. standalone-lua selects Luau for this crate’s tests and docs. The Lua API itself is unchanged.

Migration

Add mlua to your own dependencies with the runtime you embed, and keep features = ["lua"] on this crate:

openmw-config = { version = "2", features = ["lua"] }
mlua = { version = "0.12", default-features = false, features = ["luau"] }

1.1.0 stable 2026-06-04

Discovery for external tools.

Added

• from_env_or_user_config: OpenMW’s root discovery, then the user config when there is no root config. fromEnvOrUserConfig in Lua.
• try_default_root_or_user_config_path and default_user_config_file.

Fixed

• A config loaded through a symlink keeps the path it was loaded from.

1.0.5 stable 2026-05-07

APIs for importers: start empty, load if present, export flattened.

Added

• new_empty and load_optional, which start from an empty configuration without inventing an openmw.cfg.
• to_resolved_string and save_resolved_to_path: a flattened export with resolved paths and no config= or replace= entries.
• The same four in Lua: newEmpty, loadOptional, toResolvedString, saveResolvedToPath.

1.0.4 stable 2026-05-04

Added

• The root config helpers try_default_root_config_path and try_default_global_config_path, and OPENMW_GLOBAL_CONFIG_PATH.

Changed

• from_env uses OpenMW’s own root discovery: OPENMW_CONFIG, OPENMW_CONFIG_DIR, then an openmw.cfg beside the executable, then the global config. It no longer falls back to the user config.

1.0.3 stable 2026-05-01

Fixed

• Saving no longer writes the injected data-local directory back as a data= line.
• encoding= no longer gains a blank line on every save.

1.0.2 stable 2026-04-24

Added

• set_generic_settings, add_generic_setting and save_to_path.
• In Lua: genericSettings, setGenericSettings, addGenericSetting and saveToPath. Setting rows carry source and comment.

Fixed

• Saving over a read-only file on Windows.
• save_to_path checks that the destination directory is writable.

1.0.1 stable 2026-04-19

First stable release: parsing that matches OpenMW’s, Lua bindings, and Flatpak paths.

openmw-config 1.0 reads a config chain the way OpenMW does: config= entries level by level, replace= applied as it is read, and line numbers in every parse error. It adds embedded Lua bindings with a camelCase API and resolves tokens correctly inside Flatpak.

Breaking changes

• Methods that built a Vec are gone; collect the iterators instead.

Added

• Lua bindings through mlua, behind the lua feature: create_lua_module and a camelCase API.
• Flatpak-aware ?userconfig? and ?userdata?, and OPENMW_FLATPAK_ID.
• default_local_path and default_global_path, for ?local? and ?global?, with fallible try_ variants.
• user_config_ref, which leaves the configuration in place, and &str views of setting values.
• config_chain, the parser-order record of loaded and skipped configs.
• Parse errors carry the line they came from.

Changed

• Relicensed under GPL-3.0-or-later.
• dirs and shellexpand are replaced by the standard library. On Windows, the Documents folder comes from the Known Folder API.
• Queries on content files, archives, data directories and game settings are indexed.

Fixed

• config= entries load level by level, siblings before their children, as OpenMW loads them.
• replace=config discards earlier settings and queued config= entries.
• fallback= values keep their exact spelling through a round trip.
• Game settings are deduplicated by key.
• Path comparisons normalize separators.

0.1.93 stable 2026-04-06

Added

• EncodingSetting::value returns the encoding.

Fixed

• Relative config paths are made absolute, and empty ones are refused, including from the environment.
• Config paths are validated through symlinks.
• Paths keep their . and .. components instead of losing parts of the path.

0.1.92 stable 2025-10-03

Fixed

• ?userconfig? resolves correctly.
• resources= no longer adds vfs-mw: the local or global config lists it itself.

0.1.91 stable 2025-09-04

Fixed

• Android paths, again.

0.1.9 stable 2025-09-02

Fixed

• Android paths.

0.1.8 stable 2025-09-02

Added

• Android’s config and userdata directories.

0.1.7 stable 2025-07-18

Changed

• New repository URL, and the license stated explicitly.

0.1.5 stable 2025-07-03

Fixed

• Serializing a configuration wrote it onto a single line.

0.1.4 stable 2025-07-02

Changed

• The setting types are public.
• resources= and data-local= add their directories to the data directories.

0.1.3 stable 2025-06-24

Added

• OPENMW_CONFIG and OPENMW_CONFIG_DIR choose the root config.

0.1.2 stable 2025-06-17

Fixed

• The Windows user config is Documents/My Games/openmw.
• Data directories and config= entries no longer keep openmw.cfg in their paths.

0.1.1 stable 2025-06-17

Comments, unknown keys and groundcover survive a round trip.

Added

• groundcover= entries.
• Unknown key=value lines are kept as generic settings and written back.
• Comments are kept with the setting that follows them and written back.
• Typed fallback= settings, with set_game_setting taking the line’s text.
• root_config_file, root_config_dir and user_config, and presence helpers for content files and archives.
• ConfigError, one error type for the whole crate.

Fixed

• The key is user-data, not userdata.
• Content files added at runtime are attributed to the user’s openmw.cfg, not its directory.
• Singleton settings read their last definition.
• Symlinked configs no longer fail to load.

0.1.0 stable 2025-06-17

First release: read an openmw.cfg chain into one configuration.