From Vintage Story Wiki

This page was last verified for Vintage Story version 1.15.

The game provides the following convenience methods for saving and loading mod configuration data by serializing the data into JSON format.

StoreModConfig() will save your mod's configuration file to the Vintage Story app data folder within a "ModConfig" subdirectory. LoadModConfig will load the same file from that directory back into the data structure class you've defined. You can use standard JSON.NET features, such as using the [JsonIgnore] attribute for certain fields or properties that you do not wish to be serialized to file.

        /// <summary>
        /// Milo kept asking for a standardized way to load and store mod configuration data, so here you go :P
        /// For T just make a class with all fields public - this is your configuration class. Be sure to set useful default values for your settings
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="jsonSerializeableData"></param>
        /// <param name="filename"></param>
        void StoreModConfig<T>(T jsonSerializeableData, string filename);

        /// <summary>
        /// Milo kept asking for a standardized way to load and store mod configuration data, so here you go :P
        /// Recommendation: Surround this call with a try/catch in case the user made a typo while changing the configuration
        /// Returns null if the file does not exist
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="filename"></param>
        /// <returns></returns>
        T LoadModConfig<T>(string filename);

Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository