Give Feedback
0 of 0
About this mod
Adds papyrus script functions to read and write from arbitrary .ini files.
- Requirements
- Permissions and credits
- Changelogs
Adds papyrus script functions to read and write from arbitrary .ini files.
Ini files are useful for mod configuration, when the settings are supposed to be shared between all saves.
Compared to .xml or .json files, .ini files are easier to configure by hand due to their easy syntax and the option to add comments in the file.
This mod was created in order to be able to replicate MCM Helper's .ini configuration functionality on Legendary Edition.
Tips for Mod Authors:
Permissions:
When using these functions in your mod, please link this mod as a requirement instead of bundling the files with your mod. This makes it easier for the user to always get the latest version and won't require you to update your mod if this one updates.
Github: Skyrim-PapyrusIni
Ini files are useful for mod configuration, when the settings are supposed to be shared between all saves.
Compared to .xml or .json files, .ini files are easier to configure by hand due to their easy syntax and the option to add comments in the file.
This mod was created in order to be able to replicate MCM Helper's .ini configuration functionality on Legendary Edition.
Tips for Mod Authors:
- Before using the script functions, use GetPluginVersion() to ensure the user has installed the correct version and it is working correctly. If this function returns 0, the functions will not work (e.g. user has wrong or no skse version). If installed correctly, this function will return the version of PapyrusIni the user has. If your mod needs at least version 1, you should therefore use GetPluginVersion() >= 1 to check whether the functions you need are available.
- Use buffered ini operations for reading and writing multiple settings more efficiently. BufferedIni.psc contains detailed information about when and how to use buffered ini operations.
Permissions:
When using these functions in your mod, please link this mod as a requirement instead of bundling the files with your mod. This makes it easier for the user to always get the latest version and won't require you to update your mod if this one updates.
Github: Skyrim-PapyrusIni