From 313f6c2f8017a5c794557d4ad7958bd5e3552634 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Thu, 26 Jan 2017 15:54:24 -0500 Subject: update image URL in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 995bb59f..f8459006 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![](https://raw.githubusercontent.com/Gormogon/SMAPI/master/docs/imgs/SMAPI.png) +![](docs/imgs/SMAPI.png) **SMAPI** is an [open-source](LICENSE) modding API for [Stardew Valley](http://stardewvalley.net/). It takes care of loading mods into the game context, and exposes events they can use to interact -- cgit From 85ff940e6882278fe131cb15b721a09e9283b8fc Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Fri, 3 Feb 2017 22:02:54 -0500 Subject: move install package's Mono/Windows folders out of root This will hopefully reduce confusion among players who go into "Windows" instead of running install.exe. --- README.md | 63 +++++++++++----------- release-notes.md | 3 +- .../InteractiveInstaller.cs | 6 +-- src/prepare-install-package.targets | 59 ++++++++++---------- 4 files changed, 67 insertions(+), 64 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f8459006..b1062077 100644 --- a/README.md +++ b/README.md @@ -70,46 +70,47 @@ folder containing `src`). 2. In Linux or Mac: 1. Rebuild the solution in _Release_ mode. - 2. Copy `bin/Packaged/Mono` into the `SMAPI ` folder. + 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-1.x/ - Mono/ - Mods/* - Mono.Cecil.dll - Mono.Cecil.Rocks.dll - Newtonsoft.Json.dll - StardewModdingAPI - StardewModdingAPI.config.json - StardewModdingAPI.data.json - StardewModdingAPI.exe - StardewModdingAPI.exe.mdb - StardewModdingAPI.AssemblyRewriters.dll - System.Numerics.dll - System.Runtime.Caching.dll - steam_appid.txt - Windows/ - Mods/* - Mono.Cecil.dll - Mono.Cecil.Rocks.dll - Newtonsoft.Json.dll - StardewModdingAPI.config.json - StardewModdingAPI.data.json - StardewModdingAPI.exe - StardewModdingAPI.pdb - StardewModdingAPI.xml - StardewModdingAPI.AssemblyRewriters.dll - steam_appid.txt install.exe readme.txt + internal/ + Mono/ + Mods/* + Mono.Cecil.dll + Mono.Cecil.Rocks.dll + Newtonsoft.Json.dll + StardewModdingAPI + StardewModdingAPI.AssemblyRewriters.dll + StardewModdingAPI.config.json + StardewModdingAPI.data.json + StardewModdingAPI.exe + StardewModdingAPI.exe.mdb + steam_appid.txt + System.Numerics.dll + System.Runtime.Caching.dll + Windows/ + Mods/* + Mono.Cecil.dll + Mono.Cecil.Rocks.dll + Newtonsoft.Json.dll + StardewModdingAPI.AssemblyRewriters.dll + StardewModdingAPI.config.json + StardewModdingAPI.data.json + StardewModdingAPI.exe + StardewModdingAPI.pdb + StardewModdingAPI.xml + steam_appid.txt ``` - 4. Open a terminal in the `SMAPI ` folder and run `chmod 755 Mono/StardewModdingAPI`. + 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, delete the following files: - * `Mono/StardewModdingAPI.config.json` - * `Windows/StardewModdingAPI.config.json` - * `Windows/StardewModdingAPI.xml` + * `internal/Mono/StardewModdingAPI.config.json` + * `internal/Windows/StardewModdingAPI.config.json` + * `internal/Windows/StardewModdingAPI.xml` 7. Compress the two folders into `SMAPI .zip` and `SMAPI for developers.zip`. ## Advanced usage diff --git a/release-notes.md b/release-notes.md index f9c7add0..1c994b97 100644 --- a/release-notes.md +++ b/release-notes.md @@ -4,8 +4,9 @@ See [log](https://github.com/Pathoschild/SMAPI/compare/1.7...1.8). For players: -* Mods will no longer have generated `.cache` subfolders. +* Mods will no longer generate `.cache` subfolders. * Fixed multiple issues where mods failed during assembly loading. +* Tweaked install package to reduce confusion. For mod developers: * You can now create a `SemanticVersion` from a version string. diff --git a/src/StardewModdingAPI.Installer/InteractiveInstaller.cs b/src/StardewModdingAPI.Installer/InteractiveInstaller.cs index c024b128..306225a7 100644 --- a/src/StardewModdingAPI.Installer/InteractiveInstaller.cs +++ b/src/StardewModdingAPI.Installer/InteractiveInstaller.cs @@ -27,7 +27,7 @@ namespace StardewModdingApi.Installer yield return $"{Environment.GetEnvironmentVariable("HOME")}/.local/share/Steam/steamapps/common/Stardew Valley"; // Mac - yield return $"/Applications/Stardew Valley.app/Contents/MacOS"; + yield return "/Applications/Stardew Valley.app/Contents/MacOS"; yield return $"{Environment.GetEnvironmentVariable("HOME")}/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS"; // Windows @@ -110,7 +110,7 @@ namespace StardewModdingApi.Installer ** collect details ****/ Platform platform = this.DetectPlatform(); - DirectoryInfo packageDir = new DirectoryInfo(Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), platform.ToString())); + DirectoryInfo packageDir = new DirectoryInfo(Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "internal", platform.ToString())); DirectoryInfo installDir = this.InteractivelyGetInstallPath(platform); var paths = new { @@ -126,7 +126,7 @@ namespace StardewModdingApi.Installer ****/ if (!packageDir.Exists) { - this.ExitError($"The '{platform}' package directory is missing (should be at {packageDir})."); + this.ExitError($"The 'internal/{platform}' package folder is missing (should be at {packageDir})."); return; } if (!File.Exists(paths.executable)) diff --git a/src/prepare-install-package.targets b/src/prepare-install-package.targets index e903e153..f411b909 100644 --- a/src/prepare-install-package.targets +++ b/src/prepare-install-package.targets @@ -7,45 +7,46 @@ --> - $(SolutionDir)\..\bin\Packaged $(SolutionDir)\..\bin\$(Configuration)\SMAPI + $(SolutionDir)\..\bin\Packaged + $(PackagePath)\internal - + - - + + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - \ No newline at end of file + -- cgit