*** 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.

*** CONTRIBUTORS ***

Please stay consistent with the overall style that has been used throughout the project. Any changes breaking this rule will be denied.

*** LICENSING ***

Any newly contributed files must be prefixed with the GNU GPL license notification. Failing to do so will result in your changes being denied. Along with that, please put your name with the copyright notice at the top of the file when adding/editing files.

*** EVENT CONTRIBUTION ***

Please also add your name into the event spreadsheet when implementing Events, otherwise your merge and push requests will be denied. Event spreadsheet: https://docs.google.com/spreadsheets/d/1vvHVA3tb1SL6X6GbJY7FayuiuX24VMLBgLS3-KGMfGQ/edit#gid=0