Merge branch 'develop' into stable

Pathoschild · Aug 1, 2018 · 60b4119 · 60b4119
2 parents b9bc1a6 + 52cf953
commit 60b4119
Show file tree

Hide file tree

Showing 292 changed files with 12,399 additions and 7,746 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -12,12 +12,11 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 charset = utf-8
 
-[*.csproj]
+[*.{csproj,json,nuspec,targets}]
 indent_size = 2
-insert_final_newline = false
 
-[*.json]
-indent_size = 2
+[*.csproj]
+insert_final_newline = false
 
 ##########
 ## C# formatting

diff --git a/docs/CONTRIBUTING.md → .github/CONTRIBUTING.md b/docs/CONTRIBUTING.md → .github/CONTRIBUTING.md
@@ -1,16 +1,18 @@
 Do you want to...
 
 * **Ask for help using SMAPI?**  
-  Please post a message in the [SMAPI support thread](http://community.playstarbound.com/threads/108375),
-  don't create a GitHub issue.
+  Please post a message in the [SMAPI support thread](http://community.playstarbound.com/threads/108375)
+  or [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord), don't create a
+  GitHub issue.
 
 * **Report a bug?**  
   Please post a message in the [SMAPI support thread](http://community.playstarbound.com/threads/108375)
-  instead, unless you're sure it's a bug in SMAPI itself.
+  or [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord) instead, unless
+  you're sure it's a bug in SMAPI itself.
 
 * **Submit a pull request?**  
   Pull requests are welcome! If you're submitting a new feature, it's best to discuss first to make
-  sure it'll be accepted. Feel free to come chat in [#modding on Discord](https://discord.gg/kH55QXP)
+  sure it'll be accepted. Feel free to come chat in [#modding on Discord](https://stardewvalleywiki.com/Modding:Community#Discord)
   or post in the [SMAPI support thread](http://community.playstarbound.com/threads/108375).
 
   Documenting your code and using the same formatting conventions is appreciated, but don't worry too

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Report a problem with SMAPI.
+
+---
+
+<!--
+
+Only report a bug here if you're sure it's a SMAPI bug! To request support instead, see:
+   - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+   - support forum thread: https://community.playstarbound.com/threads/108375
+   - Nexus mod page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+Replace the instructions below with the bug details.
+
+-->
+
+**Describe the bug**
+A clear and concise description of what the bug is. Provide any other details you think might be relevant here.
+
+**To Reproduce**
+Exact steps which reproduce the bug, if possible. For example:
+1. Load save '...'.
+2. Walk to '....'.
+3. Click '....'.
+4. Error occurs.
+
+**Log file**
+Upload your SMAPI log to https://log.smapi.io and post a link here.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for SMAPI.
+
+---
+
+<!--
+
+GitHub issues are only used for development tasks. Please don't submit feature requests here! Instead, see...
+
+   - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+   - support forum thread: https://community.playstarbound.com/threads/108375
+   - Nexus page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+-->
diff --git a/.github/ISSUE_TEMPLATE/general.md b/.github/ISSUE_TEMPLATE/general.md
@@ -0,0 +1,15 @@
+---
+name: General
+about: Create a ticket about something else.
+
+---
+
+<!--
+
+GitHub issues are only used for development tasks. For support and questions, see...
+
+   - #modding on Discord: https://stardewvalleywiki.com/Modding:Community#Discord
+   - support forum thread: https://community.playstarbound.com/threads/108375
+   - Nexus page: https://www.nexusmods.com/stardewvalley/mods/2400
+
+-->
diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md
@@ -0,0 +1,5 @@
+GitHub issues are only used for SMAPI development tasks.
+
+To get help with SMAPI problems, you can...
+* [ask on Discord](https://stardewvalleywiki.com/Modding:Community#Discord);
+* or post in the [SMAPI support thread](https://community.playstarbound.com/threads/108375).
diff --git a/build/GlobalAssemblyInfo.cs b/build/GlobalAssemblyInfo.cs
@@ -1,5 +1,5 @@
 using System.Reflection;
 
 [assembly: AssemblyProduct("SMAPI")]
-[assembly: AssemblyVersion("2.5.5")]
-[assembly: AssemblyFileVersion("2.5.5")]
+[assembly: AssemblyVersion("2.6.0")]
+[assembly: AssemblyFileVersion("2.6.0")]
diff --git a/build/common.targets b/build/common.targets
@@ -14,65 +14,78 @@
     <GamePath Condition="!Exists('$(GamePath)')">$(HOME)/Library/Application Support/Steam/steamapps/common/Stardew Valley/Contents/MacOS</GamePath>
     <!-- Windows paths -->
     <GamePath Condition="!Exists('$(GamePath)')">C:\Program Files (x86)\GalaxyClient\Games\Stardew Valley</GamePath>
+    <GamePath Condition="!Exists('$(GamePath)')">C:\Program Files (x86)\GOG Galaxy\Games\Stardew Valley</GamePath>
     <GamePath Condition="!Exists('$(GamePath)')">C:\Program Files (x86)\Steam\steamapps\common\Stardew Valley</GamePath>
     <GamePath Condition="!Exists('$(GamePath)') AND '$(OS)' == 'Windows_NT'">$([MSBuild]::GetRegistryValueFromView('HKEY_LOCAL_MACHINE\SOFTWARE\GOG.com\Games\1453375253', 'PATH', null, RegistryView.Registry32))</GamePath>
     <GamePath Condition="!Exists('$(GamePath)') AND '$(OS)' == 'Windows_NT'">$([MSBuild]::GetRegistryValueFromView('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Steam App 413150', 'InstallLocation', null, RegistryView.Registry64, RegistryView.Registry32))</GamePath>
+
+    <!--compile constants -->
+    <DefineConstants Condition="$(OS) == 'Windows_NT'">$(DefineConstants);SMAPI_FOR_WINDOWS</DefineConstants>
   </PropertyGroup>
 
-  <!-- add references-->
+  <!-- add common references -->
+  <ItemGroup>
+    <Reference Condition="'$(OS)' == 'Windows_NT' AND '$(MSBuildProjectName)' != 'StardewModdingAPI.Toolkit' AND '$(MSBuildProjectName)' != 'StardewModdingAPI.Toolkit.CoreInterfaces'" Include="System.Management" />
+  </ItemGroup>
+
+  <!-- add game references-->
   <Choose>
-    <When Condition="$(OS) == 'Windows_NT'">
-      <PropertyGroup>
-        <DefineConstants>$(DefineConstants);SMAPI_FOR_WINDOWS</DefineConstants>
-      </PropertyGroup>
-      <ItemGroup>
-        <Reference Include="Microsoft.Xna.Framework, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
-          <Private>False</Private>
-        </Reference>
-        <Reference Include="Microsoft.Xna.Framework.Game, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
-          <Private>False</Private>
-        </Reference>
-        <Reference Include="Microsoft.Xna.Framework.Graphics, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
-          <Private>False</Private>
-        </Reference>
-        <Reference Include="Microsoft.Xna.Framework.Xact, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
-          <Private>False</Private>
-        </Reference>
-        <Reference Include="Netcode" Condition="Exists('$(GamePath)\Netcode.dll')">
-          <HintPath>$(GamePath)\Netcode.dll</HintPath>
-          <Private Condition="'$(MSBuildProjectName)' != 'StardewModdingAPI.Tests'">False</Private>
-        </Reference>
-        <Reference Include="Stardew Valley">
-          <HintPath>$(GamePath)\Stardew Valley.exe</HintPath>
-          <Private Condition="'$(MSBuildProjectName)' != 'StardewModdingAPI.Tests'">False</Private>
-        </Reference>
-        <Reference Include="xTile, Version=2.0.4.0, Culture=neutral, processorArchitecture=x86">
-          <HintPath>$(GamePath)\xTile.dll</HintPath>
-          <Private>False</Private>
-          <SpecificVersion>False</SpecificVersion>
-        </Reference>
-      </ItemGroup>
+    <When Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI' OR '$(MSBuildProjectName)' == 'StardewModdingAPI.Mods.ConsoleCommands' OR '$(MSBuildProjectName)' == 'StardewModdingAPI.Mods.SaveBackup' OR '$(MSBuildProjectName)' == 'StardewModdingAPI.Tests'">
+      <Choose>
+        <When Condition="$(OS) == 'Windows_NT'">
+          <ItemGroup>
+            <!--XNA framework-->
+            <Reference Include="Microsoft.Xna.Framework, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
+              <Private>False</Private>
+            </Reference>
+            <Reference Include="Microsoft.Xna.Framework.Game, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
+              <Private>False</Private>
+            </Reference>
+            <Reference Include="Microsoft.Xna.Framework.Graphics, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
+              <Private>False</Private>
+            </Reference>
+            <Reference Include="Microsoft.Xna.Framework.Xact, Version=4.0.0.0, Culture=neutral, PublicKeyToken=842cf8be1de50553, processorArchitecture=x86">
+              <Private>False</Private>
+            </Reference>
+
+            <!-- game DLLs -->
+            <Reference Include="Netcode">
+              <HintPath>$(GamePath)\Netcode.dll</HintPath>
+              <Private Condition="'$(MSBuildProjectName)' != 'StardewModdingAPI.Tests'">False</Private>
+            </Reference>
+            <Reference Include="Stardew Valley">
+              <HintPath>$(GamePath)\Stardew Valley.exe</HintPath>
+              <Private Condition="'$(MSBuildProjectName)' != 'StardewModdingAPI.Tests'">False</Private>
+            </Reference>
+            <Reference Include="xTile, Version=2.0.4.0, Culture=neutral, processorArchitecture=x86">
+              <HintPath>$(GamePath)\xTile.dll</HintPath>
+              <Private>False</Private>
+              <SpecificVersion>False</SpecificVersion>
+            </Reference>
+          </ItemGroup>
+        </When>
+        <Otherwise>
+          <ItemGroup>
+            <!-- MonoGame -->
+            <Reference Include="MonoGame.Framework">
+              <HintPath>$(GamePath)\MonoGame.Framework.dll</HintPath>
+              <Private>False</Private>
+              <SpecificVersion>False</SpecificVersion>
+            </Reference>
+
+            <!-- game DLLs -->
+            <Reference Include="StardewValley">
+              <HintPath>$(GamePath)\StardewValley.exe</HintPath>
+              <Private>False</Private>
+            </Reference>
+            <Reference Include="xTile">
+              <HintPath>$(GamePath)\xTile.dll</HintPath>
+              <Private>False</Private>
+            </Reference>
+          </ItemGroup>
+        </Otherwise>
+      </Choose>
     </When>
-    <Otherwise>
-      <PropertyGroup>
-        <DefineConstants>$(DefineConstants);SMAPI_FOR_UNIX</DefineConstants>
-      </PropertyGroup>
-      <ItemGroup>
-        <Reference Include="MonoGame.Framework">
-          <HintPath>$(GamePath)\MonoGame.Framework.dll</HintPath>
-          <Private>False</Private>
-          <SpecificVersion>False</SpecificVersion>
-        </Reference>
-        <Reference Include="StardewValley">
-          <HintPath>$(GamePath)\StardewValley.exe</HintPath>
-          <Private>False</Private>
-        </Reference>
-        <Reference Include="xTile">
-          <HintPath>$(GamePath)\xTile.dll</HintPath>
-          <Private>False</Private>
-        </Reference>
-      </ItemGroup>
-    </Otherwise>
   </Choose>
 
   <!-- if game path is invalid, show one user-friendly error instead of a slew of reference errors -->
@@ -82,21 +95,31 @@
 
   <!-- copy files into game directory and enable debugging (only in debug mode) -->
   <Target Name="AfterBuild">
-    <CallTarget Targets="CopySMAPI;CopyDefaultMod" Condition="'$(Configuration)' == 'Debug'" />
+    <CallTarget Targets="CopySMAPI;CopyDefaultMods" Condition="'$(Configuration)' == 'Debug'" />
   </Target>
   <Target Name="CopySMAPI" Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI'">
     <Copy SourceFiles="$(TargetDir)\$(TargetName).exe" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).config.json" DestinationFolder="$(GamePath)" />
-    <Copy SourceFiles="$(TargetDir)\StardewModdingAPI.AssemblyRewriters.dll" DestinationFolder="$(GamePath)" />
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).metadata.json" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\$(TargetName).xml" DestinationFolder="$(GamePath)" />
+    <Copy SourceFiles="$(TargetDir)\0Harmony.dll" DestinationFolder="$(GamePath)" />
+    <Copy SourceFiles="$(TargetDir)\0Harmony.pdb" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\Newtonsoft.Json.dll" DestinationFolder="$(GamePath)" />
     <Copy SourceFiles="$(TargetDir)\Mono.Cecil.dll" DestinationFolder="$(GamePath)" />
   </Target>
-  <Target Name="CopyDefaultMod" Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI.Mods.ConsoleCommands'">
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)\Mods\ConsoleCommands" />
-    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)\Mods\ConsoleCommands" Condition="Exists('$(TargetDir)\$(TargetName).pdb')" />
-    <Copy SourceFiles="$(TargetDir)\manifest.json" DestinationFolder="$(GamePath)\Mods\ConsoleCommands" />
+  <Target Name="CopyDefaultMods" Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI.Mods.ConsoleCommands' OR '$(MSBuildProjectName)' == 'StardewModdingAPI.Mods.SaveBackup'">
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" />
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" Condition="Exists('$(TargetDir)\$(TargetName).pdb')" />
+    <Copy SourceFiles="$(TargetDir)\manifest.json" DestinationFolder="$(GamePath)\Mods\$(AssemblyName)" />
+  </Target>
+  <Target Name="CopyToolkit" Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI.Toolkit' AND '$(Configuration)' == 'Debug' AND $(TargetFramework) == 'net4.5'" AfterTargets="PostBuildEvent">
+      <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)" />
+      <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)" />
+  </Target>
+  <Target Name="CopyToolkitCoreInterfaces" Condition="'$(MSBuildProjectName)' == 'StardewModdingAPI.Toolkit.CoreInterfaces' AND '$(Configuration)' == 'Debug' AND $(TargetFramework) == 'net4.5'" AfterTargets="PostBuildEvent">
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(GamePath)" />
+    <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(GamePath)" />
   </Target>
 
   <!-- launch SMAPI on debug -->