108 lines
5.0 KiB
Markdown
108 lines
5.0 KiB
Markdown
← [README](../README.md)
|
|
|
|
This file provides more technical documentation about SMAPI. If you only want to use or create
|
|
mods, this section isn't relevant to you; see the main README to use or create mods.
|
|
|
|
This document is about SMAPI itself; see also [mod build package](mod-package.md) and
|
|
[web services](web.md).
|
|
|
|
# Contents
|
|
* [Customisation](#customisation)
|
|
* [Configuration file](#configuration-file)
|
|
* [Command-line arguments](#command-line-arguments)
|
|
* [Compile flags](#compile-flags)
|
|
* [For SMAPI developers](#for-smapi-developers)
|
|
* [Compiling from source](#compiling-from-source)
|
|
* [Debugging a local build](#debugging-a-local-build)
|
|
* [Preparing a release](#preparing-a-release)
|
|
* [Release notes](#release-notes)
|
|
|
|
## Customisation
|
|
### Configuration file
|
|
You can customise some SMAPI behaviour by editing the `smapi-internal/config.json` file in your
|
|
game folder. See documentation in the file for more info.
|
|
|
|
### Command-line arguments
|
|
The SMAPI installer recognises three command-line arguments:
|
|
|
|
argument | purpose
|
|
-------- | -------
|
|
`--install` | Preselects the install action, skipping the prompt asking what the user wants to do.
|
|
`--uninstall` | Preselects the uninstall action, skipping the prompt asking what the user wants to do.
|
|
`--game-path "path"` | Specifies the full path to the folder containing the Stardew Valley executable, skipping automatic detection and any prompt to choose a path. If the path is not valid, the installer displays an error.
|
|
|
|
SMAPI itself recognises two arguments **on Windows only**, but these are intended for internal use
|
|
or testing and may change without warning. On Linux/Mac, see _environment variables_ below.
|
|
|
|
argument | purpose
|
|
-------- | -------
|
|
`--no-terminal` | SMAPI won't write anything to the console window. (Messages will still be written to the log file.)
|
|
`--mods-path` | The path to search for mods, if not the standard `Mods` folder. This can be a path relative to the game folder (like `--mods-path "Mods (test)"`) or an absolute path.
|
|
|
|
### Environment variables
|
|
The above SMAPI arguments don't work on Linux/Mac due to the way the game launcher works. You can
|
|
set temporary environment variables instead. For example:
|
|
> SMAPI_MODS_PATH="Mods (multiplayer)" /path/to/StardewValley
|
|
|
|
environment variable | purpose
|
|
-------------------- | -------
|
|
`SMAPI_NO_TERMINAL` | Equivalent to `--no-terminal` above.
|
|
`SMAPI_MODS_PATH` | Equivalent to `--mods-path` above.
|
|
|
|
|
|
### Compile flags
|
|
SMAPI uses a small number of conditional compilation constants, which you can set by editing the
|
|
`<DefineConstants>` element in `SMAPI.csproj`. Supported constants:
|
|
|
|
flag | purpose
|
|
---- | -------
|
|
`SMAPI_FOR_WINDOWS` | Whether SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`.
|
|
|
|
## For SMAPI developers
|
|
### Compiling from source
|
|
Using an official SMAPI release is recommended for most users.
|
|
|
|
SMAPI often uses the latest C# syntax. You may need the latest version of
|
|
[Visual Studio](https://www.visualstudio.com/vs/community/) on Windows,
|
|
[MonoDevelop](https://www.monodevelop.com/) on Linux,
|
|
[Visual Studio for Mac](https://www.visualstudio.com/vs/visual-studio-mac/), or an equivalent IDE
|
|
to compile it. It uses build configuration derived from the
|
|
[crossplatform mod config](https://smapi.io/package/readme) to detect your current OS automatically
|
|
and load the correct references. Compile output will be placed in a `bin` folder at the root of the
|
|
git repository.
|
|
|
|
### Debugging a local build
|
|
Rebuilding the solution in debug mode will copy the SMAPI files into your game folder. Starting
|
|
the `SMAPI` project with debugging from Visual Studio (on Mac or Windows) will launch SMAPI with
|
|
the debugger attached, so you can intercept errors and step through the code being executed. This
|
|
doesn't work in MonoDevelop on Linux, unfortunately.
|
|
|
|
### Preparing a release
|
|
To prepare a crossplatform SMAPI release, you'll need to compile it on two platforms. See
|
|
[crossplatforming info](https://stardewvalleywiki.com/Modding:Modder_Guide/Test_and_Troubleshoot#Testing_on_all_platforms)
|
|
on the wiki for the first-time setup.
|
|
|
|
1. Update the version number in `.root/build/common.targets` and `Constants::Version`. Make sure
|
|
you use a [semantic version](https://semver.org). Recommended format:
|
|
|
|
build type | format | example
|
|
:--------- | :----------------------- | :------
|
|
dev build | `<version>-alpha.<date>` | `3.0-alpha.20171230`
|
|
prerelease | `<version>-beta.<count>` | `3.0-beta.2`
|
|
release | `<version>` | `3.0`
|
|
|
|
2. In Windows:
|
|
1. Rebuild the solution in Release mode.
|
|
2. Copy `windows-install.*` from `bin/SMAPI installer` and `bin/SMAPI installer for developers` to
|
|
Linux/Mac.
|
|
|
|
3. In Linux/Mac:
|
|
1. Rebuild the solution in Release mode.
|
|
2. Add the `windows-install.*` files to the `bin/SMAPI installer` and
|
|
`bin/SMAPI installer for developers` folders.
|
|
3. Rename the folders to `SMAPI <version> installer` and `SMAPI <version> installer for developers`.
|
|
4. Zip the two folders.
|
|
|
|
## Release notes
|
|
See [release notes](../release-notes.md).
|