File information
Created by
SpontanCombust AeltothUploaded by
SpontanCombustVirus scan
About this mod
Framework for modding Witcher 3 that simplifies the pipeline of using mod settings by generating WitcherScript code based directly on mod menu XML and providing extendible interface for reacting to changes of settings.
- Requirements
- Permissions and credits
Synopsis
Framework for modding Witcher 3 that simplifies the pipeline of using mod settings by generating WitcherScript code based directly on mod menu XML and providing extendible interface for reacting to changes of settings. Compatible with game version 4.03.
Overview
Witcher 3 allows for creating custom mod menus which provide an interface between the mod developer and the end user to further customize their experience. The way settings are accessed in game's scripts is not complicated, but can often result in very boilerplaty code and situations when settings can be fetched improperly simply due to some typo. This framework is trying to midigate that.
First part of this framwork is the menu xml parser. It turns the mod menu xml into WitcherScript code which mirrors the structure of customisable variables in the xml and assures on compile time that the developer uses their variables properly - no way for typos or bad type cast.
Second part of this framework is WitcherScript code that updates generated by parser settings class and even notifies you about it.
Instructions for mod users
1. Download modSettingsFramework from the newest version or version specified by the developer
2. Install it like any other Witcher 3 mod by dropping what's inside into your Mods folder
3. Use Script Merger to solve any conflicts
Framework version support:
- 0.4+ for game version 4.04
- 0.3.0 - 0.3.1 for game version 4.03
- 0.1.0 - 0.2.0 for game version 1.32 (requires Community Patch - Base)
Instructions for mod authors and more details can be found on the Git repository:
https://github.com/SpontanCombust/tw3-settings-framework