summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-04-23 02:05:14 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2021-04-23 02:05:14 -0400
commit47a806533b9fbcfe3fc771316283a7734702baae (patch)
treef0ec619bb488febfc7f9766e3fb2e12d4f466c77 /docs
parent665c6806d3797f8329ef8c6fcaa80d469fef5005 (diff)
downloadSMAPI-47a806533b9fbcfe3fc771316283a7734702baae.tar.gz
SMAPI-47a806533b9fbcfe3fc771316283a7734702baae.tar.bz2
SMAPI-47a806533b9fbcfe3fc771316283a7734702baae.zip
add 64-bit support to the SMAPI installer (#767)
Diffstat (limited to 'docs')
-rw-r--r--docs/release-notes.md4
-rw-r--r--docs/technical/smapi.md17
2 files changed, 13 insertions, 8 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 748e62c5..9de285ae 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -9,13 +9,13 @@
## Upcoming release
* For players:
+ * Added support for unofficial 64-bit Stardew Valley, including automatic support in the SMAPI installer.
+ * Added update checks for Stardew64Installer if it patched the game.
* When many mods fail to load, root dependencies are now listed in their own group so it's easier to see which ones you should try updating first.
* On macOS, the `StardewModdingAPI.bin.osx` file is no longer overwritten if it's identical to avoid resetting file permissions (thanks to 007wayne!).
- * Added update checks for Stardew64Installer if it patched the game.
* Fixed error for non-English players after returning to title, reloading, and entering town with a completed movie theater.
* Fixed `world_clear` console command not removing resource clumps outside the farm and secret woods.
* Fixed inconsistent spelling/style for 'macOS'.
- * Internal changes to prepare for unofficial 64-bit.
* For modders:
* Added asset propagation for `Data\Concessions`.
diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md
index ca1631cd..b64239c1 100644
--- a/docs/technical/smapi.md
+++ b/docs/technical/smapi.md
@@ -82,7 +82,9 @@ To prepare a crossplatform SMAPI release, you'll need to compile it on two platf
[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 numbers in `build/common.targets`, `Constants`, and the `manifest.json` for
+1. [Install a separate 64-bit version of Stardew Valley](https://github.com/Steviegt6/Stardew64Installer#readme)
+ on Windows.
+2. Update the version numbers in `build/common.targets`, `Constants`, and the `manifest.json` for
bundled mods. Make sure you use a [semantic version](https://semver.org). Recommended format:
build type | format | example
@@ -90,12 +92,15 @@ on the wiki for the first-time setup.
dev build | `<version>-alpha.<date>` | `3.0.0-alpha.20171230`
prerelease | `<version>-beta.<date>` | `3.0.0-beta.20171230`
release | `<version>` | `3.0.0`
-
-2. In Windows:
+3. In Windows:
1. Rebuild the solution with the _release_ solution configuration.
- 2. Copy `bin/SMAPI installer` and `bin/SMAPI installer for developers` to Linux/macOS.
-
-3. In Linux/macOS:
+ 2. Back up the `bin/SMAPI installer` and `bin/SMAPI installer for developers` folders.
+ 3. Edit `common.targets` and uncomment the Stardew Valley 64-bit section at the top.
+ 4. Rebuild the solution again.
+ 5. Rename the compiled `StardewModdingAPI.exe` file to `StardewModdingAPI-x64.exe`, and copy it
+ into the `windows-install.dat` files from step ii.
+ 6. Copy the folders from step ii to Linux/MacOS.
+4. In Linux/macOS:
1. Rebuild the solution with the _release_ solution configuration.
2. Add the `windows-install.*` files from Windows to the `bin/SMAPI installer` and
`bin/SMAPI installer for developers` folders compiled on Linux.