Getting Started

Contents

• Requirements
• Project Setup

Requirements

• An SMAPI Mod
• StardewConfigFramework.dll
• Visual Studio

Project Setup

After setting up an SMAPI mod there are a few quick steps to adding your mod to the Mod Config tab.

Add Project Reference

First, we need to allow your project to reference the necessary classes.

1. Open the project Solution in Visual Studio
2. Right click the References option in the Solution Explorer, usually on the left side, and select Edit References.
3. Select the .Net Assembly tab and browse for the downloaded StardewConfigFramework.dll. Download here. Ensure the assembly file is selected with a check by the name.
4. That's it! Hit OK, and you now have a reference to the Framework.

Add Dependencies to Manifest

In order for the Framework to be accessed it must be loaded prior to your mod, to ensure this we will add StardewConfigFramework as a dependency. Add the following lines to your manifest.json file.

"Dependencies": [
  { "UniqueID": "Juice805.StardewConfigMenu" }
]

For Example, your manifest may look like this:

{
    "Name": "Framework Example",
    "Authour": "Juice805",
    "Version": {
        "MajorVersion": 1,
        "MinorVersion": 0,
        "PatchVersion": 0,
        "Build": ""
    },
    "Description": "A short description of your app.",
    "UniqueID": "You.ModID",
    "EntryDll": "Example.dll",
    "Dependencies": [
    { "UniqueID": "Juice805.StardewConfigMenu" }
    ]
}