StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

This commit is contained in:
Jesse Plamondon-Willard 2017-03-12 21:36:50 -04:00
parent ab89e42201
commit 34f714b958
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -103,22 +103,22 @@ folder containing `src`).
``` ```
4. Open a terminal in the `SMAPI <version>` folder and run `chmod 755 internal/Mono/StardewModdingAPI`. 4. Open a terminal in the `SMAPI <version>` folder and run `chmod 755 internal/Mono/StardewModdingAPI`.
5. Copy & paste the `SMAPI <version>` folder as `SMAPI <version> for developers`. 5. Copy & paste the `SMAPI <version>` folder as `SMAPI <version> for developers`.
6. In the `SMAPI <version>` folder, delete the following files: 6. In the `SMAPI <version>` folder...
* `internal/Mono/StardewModdingAPI.config.json` * edit `internal/Mono/StardewModdingAPI.config.json` and
* `internal/Windows/StardewModdingAPI.config.json` `internal/Windows/StardewModdingAPI.config.json` to disable developer mode;
* `internal/Windows/StardewModdingAPI.xml` * delete `internal/Windows/StardewModdingAPI.xml`.
7. Compress the two folders into `SMAPI <version>.zip` and `SMAPI <version> for developers.zip`. 7. Compress the two folders into `SMAPI <version>.zip` and `SMAPI <version> for developers.zip`.
## Advanced usage ## Advanced usage
### Configuration file ### Configuration file
You can customise the SMAPI behaviour by editing the `StardewModdingAPI.config.json` file in your You can customise the SMAPI behaviour by editing the `StardewModdingAPI.config.json` file in your
game folder. If it's missing, it'll be generated automatically next time SMAPI runs. It contains game folder. It contains these fields:
these fields:
field | purpose field | purpose
----- | ------- ----- | -------
`DeveloperMode` | Default `false` (except in _SMAPI for developers_ releases). Whether to enable features intended for mod developers. Currently this only makes `TRACE`-level messages appear in the console. `DeveloperMode` | Default `false` (except in _SMAPI for developers_ releases). Whether to enable features intended for mod developers. Currently this only makes `TRACE`-level messages appear in the console.
`CheckForUpdates` | Default `true`. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background. `CheckForUpdates` | Default `true`. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background.
`IncompatibleMods` | A list of mods SMAPI considers incompatible and will refuse to load. Changing this field is not recommended.
### Command-line arguments ### Command-line arguments
SMAPI recognises the following command-line arguments. These are intended for internal use and may SMAPI recognises the following command-line arguments. These are intended for internal use and may