1. Are you new to Stardew Valley modding? Check out our Stardew Valley Mod Installation Mega-Guide for the latest information and to ask questions to the very knowledgeable modding community!
  2. Welcome to the site! Why not register today to receive access to many more features on Stardew Valley Mods!
  3. Are you sick of seeing advertisements? Do you want to support your favorite Stardew Mods site in developing new features for the site?

    We now offer premium subscriptions! Click here for more information!

Mod Installation Mega-Guide

Discussion in 'Help' started by Admin, Mar 27, 2016.

  1. Admin

    Admin Administrator Staff Member

    Joined:
    Mar 8, 2016
    Messages:
    31
    Likes Received:
    15
    Are you new to Stardew Valley modding and would like a quick run down? Look no further!

    Currently there are two modding frameworks that mods are being developed with:
    • Storm API
    • SMAPI (Stardew Modding API)
     
  2. Admin

    Admin Administrator Staff Member

    Joined:
    Mar 8, 2016
    Messages:
    31
    Likes Received:
    15
    STORM
    Storm is a modding API for the game Stardew Valley. Storm works by dynamically modifying the game's executable at runtime, to expose data, provide callbacks, and provide abstraction for a stable, maintainable modding environment.
    We use Mono.Cecil for our MSIL injection, DynamicProxy for creating instances of any games classes, and Json.NET for serialization.

    INSTALLATION/USAGE
    Launcher: Compile Storm, and place it in the same directory as the game. Launching Storm will cause the Game to be launched.
    Mods: Mods each have their own individual folder, and go in AppData/StardewValley/Mods/mod-name/

    COMPILING
    Pre-requisites
    The following are pre-requisites to being able to download and build the Storm API

    • Visual Studio Community Edition 2015
    • XNA must be installed (probably already is if you're running Stardew Valley)
    • Install Git for Windows from https://git-scm.com/download/win
    Downloading the Project
    • Open a Command Prompt (WIN+R, cmd then Enter)
    • Navigate to a folder where you'd like the files to be downloaded (such as c:\devel\ for example)
    • Run the following command: git clone https://gitlab.com/Demmonic/Storm.git
    Opening and building the project
    (Note: ./ refers to the root of the project where it was downloaded!)

    • Open ./Storm/Storm.sln in VS 2015
    • You should be able to build it directly by going to the Build menu, then Build Solution
    Copying the appropriate files
    There are different copies to be made:

    • ./Dependencies/injectors/interface_injectors.json and ./Dependencies/injectors/secondary/ should be copied to %APPDATA%/StardewValley/Storm/
    • All files from ./Storm/Storm/bin/Debug/ should be copied to the StardewValley.exe installation folder.
    Other notes
    • Mod DLLS should be under %APPDATA%/StardewValley/Mods/yourmodname/
    • Run StormLoader.exe from the game install path to launch with mods.
    Pre-compiled
    Are you still a bit confused? You can download a pre-compiled build of Storm from handsomematt's repository here.
     
  3. Admin

    Admin Administrator Staff Member

    Joined:
    Mar 8, 2016
    Messages:
    31
    Likes Received:
    15
    SMAPI
    SMAPI (Stardew Mapping Application Programming Interface) is a tool to help modders make changes to Stardew. It is a standalone executable which goes alongside your Stardew.exe.

    Latest Version: 0.39.2
    • Redoes how Manifests and Configs are handled. The Config class was completely rewritten.
    Installation
    To install SMAPI:

    • Firstly, make sure you have .NET 4.5. You can get it here: https://www.microsoft.com/en-gb/download/details.aspx?id=30653
    • Download the the latest release binary here.
    • Extract the zip file alongside your Stardew.exe, for example, if using Steam this would be somewhere like C:/ProgramFiles/Steam/steamapps/common/StardewValley
    • To launch SMAPI, launch StardewValleyModdingAPI.exe
    To install mods:

    • To install mods just download the mod's .DLL file, and place it in %appdata%\StardewValley\Mods. SMAPI will take care of the rest!
     
  4. Ysabet

    Ysabet New Member

    Joined:
    May 29, 2016
    Messages:
    2
    Likes Received:
    1
    Got a newbie question for ya....

    When installing mods, do they affect all your game saves, or can you select games to apply the mods to? In other words, can I play one save vanilla and one in a mod version?

    Thank you!

    Lisa
    The Countrified Coffeeholic
     
Advertisement

Share This Page