Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alca259/mods-game-stardewvalley


https://github.com/alca259/mods-game-stardewvalley

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

This repository contains my SMAPI mods for Stardew Valley. See the individual mods:

* [Hay luck](HayLuck)

## Compiling the mods
Installing stable releases from Nexus Mods is recommended for most users. If you really want to
compile the mod yourself, read on.

These mods use the [crossplatform build config](https://github.com/Pathoschild/Stardew.ModBuildConfig#readme)
so they can be built on Linux, Mac, and Windows without changes. See [the build config documentation](https://github.com/Pathoschild/Stardew.ModBuildConfig#readme)
for troubleshooting.

### Compiling a mod for testing
To compile a mod and add it to your game's `Mods` directory:

1. Rebuild the project in [Visual Studio](https://www.visualstudio.com/vs/community/) or [MonoDevelop](http://www.monodevelop.com/).
This will compile the code and package it into the mod directory.
2. Launch the project with debugging.
This will start the game through SMAPI and attach the Visual Studio debugger.

### Compiling a mod for release
To package a mod for release:

1. Delete the mod's directory in `Mods` at your game folder.
(This ensures the package is clean and has default configuration.)
2. Recompile the mod per the previous section.
3. Create a zip file of the mod's folder in the `Mods` folder. The zip name should include the
mod name and version (like `MyMod-1.0.zip`).