Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 1.61 KB

README.md

File metadata and controls

38 lines (31 loc) · 1.61 KB
Raw

FeTK is a Stardew Valley mod framework which is a collection of helper functions and mod services. It simplifies common developer tasks building Stardew-Valley mods and empowers developers to build rich and high-quality mod experiences!

This documentation is for modders. If you are a player, please see the Nexus page instead.

Contents

Install

  1. Install the latest version of SMAPI.
  2. Install this mod from Nexus mods.
  3. Run the game using SMAPI.

Features

For a list of APIs this framework provides please check the documentation here.

Develop

Make sure you have the framework installed. Include the following mod dependency in the manifest of your consuming mod:

"Dependencies": [
    {
      "UniqueID": "Felix-Dev.FeTK",
      "MinimumVersion": "1.0.0" // optional; pick the required minimum version you need
    }
  ]

If you want to use SMAPI-mod specific APIs, you will also need to add a reference to the FeTK.dll library file to your project. This library is included in the downloaded mod folder.

Compatibility

For compatibility please check the documentation for each particular framework feature.

See also