From 41e3c2802174562f356116eda81c8ddfff1edaeb Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 18 Nov 2018 00:44:56 -0500 Subject: fix installer allowing custom mods to be bundled with the install (#602) This led to confusion since the installer didn't copy mod subfolders correctly. The installer now explains where to add custom mods instead. --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 5762c623..6288f0bd 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -18,6 +18,7 @@ * Fixed friendly error no longer shown when SMAPI isn't run from the game folder. * Fixed some Windows install paths not detected. * Fixed installer duplicating bundled mods if you moved them after the last install. + * Fixed installer allowing custom mods to be bundled with the install. * Fixed translation issues not shown as warnings. * Fixed dependencies not correctly enforced if the dependency is installed but failed to load. * Fixed some errors logged as SMAPI instead of the affected mod. -- cgit From e5bc00e7a25a98338dd6b3795d6d229a662ab004 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 18 Nov 2018 00:47:35 -0500 Subject: hide installer's bundled files to avoid confusion (#602) --- docs/release-notes.md | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/release-notes.md b/docs/release-notes.md index 6288f0bd..d39e6f3e 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -5,6 +5,7 @@ * Reorganised SMAPI files: * Most SMAPI files are now tucked into a `smapi-internal` subfolder. * Save backups are now in a `save-backups` subfolder, so they're easier to access. Note that previous backups will be deleted when you update. + * Simplified the installer files to avoid confusion. * Added support for organising mods: * You can now group mods into subfolders to organise them. * You can now mark a mod folder ignored by starting the name with a dot (like `.disabled mods`). -- cgit From 48b9acb074967b03bdacff1fc357d4c8801ec1d6 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 18 Nov 2018 00:51:30 -0500 Subject: add build logic from the custom scripts (#602) --- docs/technical-docs.md | 53 +++++++++++--------------------------------------- 1 file changed, 11 insertions(+), 42 deletions(-) (limited to 'docs') diff --git a/docs/technical-docs.md b/docs/technical-docs.md index 4a8f45f1..88c1a91f 100644 --- a/docs/technical-docs.md +++ b/docs/technical-docs.md @@ -44,7 +44,7 @@ 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:Creating_a_SMAPI_mod#Test_on_all_platforms) +[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 `GlobalAssemblyInfo.cs` and `Constants::Version`. Make sure you use a @@ -57,47 +57,16 @@ on the wiki for the first-time setup. release | `` | `3.0` 2. In Windows: - 1. Rebuild the solution in _Release_ mode. - 2. Rename `bin/Packaged` to `SMAPI ` (e.g. `SMAPI 3.0`). - 2. Transfer the `SMAPI ` folder to Linux or Mac. - _This adds the installer executable and Windows files. We'll do the rest in Linux or Mac, - since we need to set Unix file permissions that Windows won't save._ - -2. In Linux or Mac: - 1. Rebuild the solution in _Release_ mode. - 2. Copy `bin/internal/Packaged/Mono` into the `SMAPI ` folder. - 3. If you did everything right so far, you should have a folder like this: - - ``` - SMAPI 3.0 installer/ - install on Linux.sh - install on Mac.command - install on Windows.exe - README.txt - internal/ - Mono/ - Mods/* - smapi-internal/* - StardewModdingAPI - StardewModdingAPI.exe - StardewModdingAPI.pdb - StardewModdingAPI.xml - steam_appid.txt - Windows/ - Mods/* - smapi-internal/* - StardewModdingAPI.exe - StardewModdingAPI.pdb - StardewModdingAPI.xml - steam_appid.txt - ``` - 4. Open a terminal in the `SMAPI ` folder and run `chmod 755 internal/Mono/StardewModdingAPI`. - 5. Copy & paste the `SMAPI ` folder as `SMAPI for developers`. - 6. In the `SMAPI ` folder... - * edit `internal/Mono/StardewModdingAPI.config.json` and - `internal/Windows/StardewModdingAPI.config.json` to disable developer mode; - * delete `internal/Windows/StardewModdingAPI.xml`. - 7. Compress the two folders into `SMAPI .zip` and `SMAPI for developers.zip`. + 1. Rebuild the solution in Release mode. + 2. Copy `bundle.windows.zipped` 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 `bundle.windows.zipped` files to the `bin/SMAPI installer` and + `bin/SMAPI installer for developers` folders. + 3. Rename the folders to `SMAPI installer` and `SMAPI installer for developers`. + 4. Zip the two folders. ## Customisation ### Configuration file -- cgit From ebbbf6fd58f3baf2918eca4c44b0e0b177c9c366 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 18 Nov 2018 01:45:36 -0500 Subject: shorten bundle file names (#602) --- docs/technical-docs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/technical-docs.md b/docs/technical-docs.md index 88c1a91f..83e4ea2b 100644 --- a/docs/technical-docs.md +++ b/docs/technical-docs.md @@ -58,12 +58,12 @@ on the wiki for the first-time setup. 2. In Windows: 1. Rebuild the solution in Release mode. - 2. Copy `bundle.windows.zipped` from `bin/SMAPI installer` and `bin/SMAPI installer for developers` - to Linux/Mac. + 2. Copy `windows.dat` 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 `bundle.windows.zipped` files to the `bin/SMAPI installer` and + 2. Add the `windows.dat` files to the `bin/SMAPI installer` and `bin/SMAPI installer for developers` folders. 3. Rename the folders to `SMAPI installer` and `SMAPI installer for developers`. 4. Zip the two folders. -- cgit