summaryrefslogtreecommitdiff
path: root/README.md
blob: 6ea731d1731e278191021122d0477d4ecd719225 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
**Stardew.ModBuildConfig** is an open-source NuGet package which automates the build configuration
for crossplatform [Stardew Valley](http://stardewvalley.net/) mods that use SMAPI.

The configuration detects the operating system (Linux, Mac, or Windows) and the Stardew Valley
install path, and injects the correct references to Stardew Valley, SMAPI, and XNA/MonoGame.
It also adds a `GamePath` variable which can be used to automate mod installation during testing
if desired.

## Contents
* [Installation](#installation)
* [Configuration](#configuration)
* [Versions](#versions)
* [See also](#see-also)

## Installation
### New mod
_TODO_

### Migrating an existing mod
_TODO_

## Configuration
_TODO_

## Versions
_TODO_

## See also
_TODO_
* <s>NuGet package</s>
* <s>Discussion thread</s>