diff options
| -rw-r--r-- | README.md | 67 | ||||
| -rw-r--r-- | src/StardewModdingAPI.Installer/StardewModdingAPI.Installer.csproj | 5 | ||||
| -rw-r--r-- | src/StardewModdingAPI/Framework/DeprecationManager.cs | 12 | ||||
| -rw-r--r-- | src/StardewModdingAPI/Framework/UserSettings.cs | 9 | ||||
| -rw-r--r-- | src/StardewModdingAPI/Program.cs | 15 | ||||
| -rw-r--r-- | src/StardewModdingAPI/StardewModdingAPI-settings.json | 4 | ||||
| -rw-r--r-- | src/StardewModdingAPI/StardewModdingAPI.csproj | 8 |
7 files changed, 85 insertions, 35 deletions
@@ -37,9 +37,8 @@ placed in a `bin` directory at the root of the git repository. ### Preparing a release To prepare a crossplatform SMAPI release, you'll need to compile it on two platforms. See _[crossplatforming a SMAPI mod](http://canimod.com/guides/crossplatforming-a-smapi-mod#preparing-a-mod-release)_ -for the first-time setup. - -For simplicity, all paths are relative to the root of the repository (the directory containing `src`). +for the first-time setup. For simplicity, all paths are relative to the root of the repository (the +directory containing `src`). 1. Update the version number in `AssemblyInfo.cs` and `Constants::Version`. Make sure you use a [semantic version](http://semver.org). Recommended format: @@ -52,35 +51,43 @@ For simplicity, all paths are relative to the root of the repository (the direct 2. In Windows: 1. Rebuild the solution in _Release_ mode. - 2. Transfer the `bin/Release/~Package` directory to Linux or Mac. + 2. Rename `bin/Packaged` to `SMAPI-<version>` (e.g. `SMAPI-1.0`). + 2. Transfer the `SMAPI-<version>` directory 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/Release/~Package/Mono` into the package directory you transferred from Windows. - 3. Open a terminal in your package directory and run `chmod 755 Mono/StardewModdingAPI`. - 4. Rename your package directory to `SMAPI-<version>-installer`. - 5. Compress it into a `SMAPI-<version>.zip` file. - -If you did everything right, you should have a release file like this: - -``` -SMAPI-1.0.zip - SMAPI-1.0-installer/ - Mono/ - Mods/* - Newtonsoft.Json.dll - StardewModdingAPI - StardewModdingAPI.exe - StardewModdingAPI.exe.mdb - System.Numerics.dll - steam_appid.txt - Windows/ - Mods/* - StardewModdingAPI.exe - StardewModdingAPI.pdb - steam_appid.txt - install.exe - readme.txt -``` + 2. Copy `bin/Packaged/Mono` into the `SMAPI-<version>` directory. + 3. If you did everything right so far, you should have a directory like this: + + ``` + SMAPI-1.0/ + Mono/ + Mods/* + Newtonsoft.Json.dll + StardewModdingAPI + StardewModdingAPI.exe + StardewModdingAPI.exe.mdb + StardewModdingAPI.xml + StardewModdingAPI-settings.json + System.Numerics.dll + steam_appid.txt + Windows/ + Mods/* + StardewModdingAPI.exe + StardewModdingAPI.pdb + StardewModdingAPI.xml + StardewModdingAPI-settings.json + steam_appid.txt + install.exe + readme.txt + ``` + 4. Open a terminal in the `SMAPI-<version>` directory and run `chmod 755 Mono/StardewModdingAPI`. + 5. Copy & paste the `SMAPI-<version>` directory as `SMAPI-<version>-for-developers`. + 6. In the `SMAPI-<version>` directory, delete the following files: + * `Mono/StardewModdingAPI.xml` + * `Mono/StardewModdingAPI-settings.json` + * `Windows/StardewModdingAPI.xml` + * `Windows/StardewModdingAPI-settings.json` + 7. Compress the two folders into `SMAPI-<version>.zip` and `SMAPI-<version>-for-developers.zip`.
\ No newline at end of file diff --git a/src/StardewModdingAPI.Installer/StardewModdingAPI.Installer.csproj b/src/StardewModdingAPI.Installer/StardewModdingAPI.Installer.csproj index e5271e96..4242cb94 100644 --- a/src/StardewModdingAPI.Installer/StardewModdingAPI.Installer.csproj +++ b/src/StardewModdingAPI.Installer/StardewModdingAPI.Installer.csproj @@ -51,7 +51,7 @@ <!-- package files --> <Target Name="AfterBuild"> <PropertyGroup> - <CompiledInstallerPath>$(SolutionDir)\..\bin\$(Configuration)\~Package</CompiledInstallerPath> + <CompiledInstallerPath>$(SolutionDir)\..\bin\Packaged</CompiledInstallerPath> <CompiledSmapiPath>$(SolutionDir)\..\bin\$(Configuration)\SMAPI</CompiledSmapiPath> </PropertyGroup> <ItemGroup> @@ -66,6 +66,8 @@ <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\Newtonsoft.Json.dll" DestinationFolder="$(CompiledInstallerPath)\Mono" /> <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.exe" DestinationFolder="$(CompiledInstallerPath)\Mono" /> <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.exe.mdb" DestinationFolder="$(CompiledInstallerPath)\Mono" /> + <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.xml" DestinationFolder="$(CompiledInstallerPath)\Windows" /> + <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI-settings.json" DestinationFolder="$(CompiledInstallerPath)\Windows" /> <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\System.Numerics.dll" DestinationFolder="$(CompiledInstallerPath)\Mono" /> <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\unix-launcher.sh" DestinationFiles="$(CompiledInstallerPath)\Mono\StardewModdingAPI" /> <Copy Condition="$(OS) != 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\steam_appid.txt" DestinationFolder="$(CompiledInstallerPath)\Mono" /> @@ -74,6 +76,7 @@ <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.exe" DestinationFolder="$(CompiledInstallerPath)\Windows" /> <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.pdb" DestinationFolder="$(CompiledInstallerPath)\Windows" /> <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI.xml" DestinationFolder="$(CompiledInstallerPath)\Windows" /> + <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\StardewModdingAPI-settings.json" DestinationFolder="$(CompiledInstallerPath)\Windows" /> <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="$(CompiledSmapiPath)\steam_appid.txt" DestinationFolder="$(CompiledInstallerPath)\Windows" /> <Copy Condition="$(OS) == 'Windows_NT'" SourceFiles="@(CompiledMods)" DestinationFolder="$(CompiledInstallerPath)\Windows\Mods\%(RecursiveDir)" /> </Target> diff --git a/src/StardewModdingAPI/Framework/DeprecationManager.cs b/src/StardewModdingAPI/Framework/DeprecationManager.cs index a3d1ea41..0c5a49f9 100644 --- a/src/StardewModdingAPI/Framework/DeprecationManager.cs +++ b/src/StardewModdingAPI/Framework/DeprecationManager.cs @@ -19,6 +19,13 @@ namespace StardewModdingAPI.Framework /********* + ** Accessors + *********/ + /// <summary>Whether <see cref="DeprecationLevel.Notice"/>-level deprecation messages should be shown in the console.</summary> + public bool SendNoticesToConsole { get; set; } + + + /********* ** Public methods *********/ /// <summary>Register a mod as a possible source of deprecation warnings.</summary> @@ -63,7 +70,10 @@ namespace StardewModdingAPI.Framework switch (severity) { case DeprecationLevel.Notice: - Log.LogToFile(message); + if (this.SendNoticesToConsole) + Log.Debug($"[DEV] {message}"); + else + Log.LogToFile(message); break; case DeprecationLevel.Info: diff --git a/src/StardewModdingAPI/Framework/UserSettings.cs b/src/StardewModdingAPI/Framework/UserSettings.cs new file mode 100644 index 00000000..199d19b3 --- /dev/null +++ b/src/StardewModdingAPI/Framework/UserSettings.cs @@ -0,0 +1,9 @@ +namespace StardewModdingAPI.Framework +{ + /// <summary>Contains user settings from SMAPI's JSON configuration file.</summary> + internal class UserSettings + { + /// <summary>Whether to enable development features.</summary> + public bool DeveloperMode { get; set; } + } +} diff --git a/src/StardewModdingAPI/Program.cs b/src/StardewModdingAPI/Program.cs index e9e357d5..047d74c7 100644 --- a/src/StardewModdingAPI/Program.cs +++ b/src/StardewModdingAPI/Program.cs @@ -8,6 +8,7 @@ using System.Threading; using System.Windows.Forms; #endif using Microsoft.Xna.Framework.Graphics; +using Newtonsoft.Json; using StardewModdingAPI.Events; using StardewModdingAPI.Framework; using StardewModdingAPI.Inheritance; @@ -67,6 +68,18 @@ namespace StardewModdingAPI // set thread culture for consistent log formatting Thread.CurrentThread.CurrentCulture = CultureInfo.CreateSpecificCulture("en-GB"); + // load user settings + { + string settingsPath = $@"{Constants.ExecutionPath}\{typeof(Program).Assembly.GetName().Name}-settings.json"; + if (File.Exists(settingsPath)) + { + string json = File.ReadAllText(settingsPath); + UserSettings settings = JsonConvert.DeserializeObject<UserSettings>(json); + Program.DeprecationManager.SendNoticesToConsole = settings?.DeveloperMode == true; + } + + } + // hook into & launch the game try { @@ -271,7 +284,7 @@ namespace StardewModdingAPI } // log deprecated fields - if(manifest.UsedAuthourField) + if (manifest.UsedAuthourField) Program.DeprecationManager.Warn(manifest.Name, $"{nameof(Manifest)}.{nameof(Manifest.Authour)}", "1.0", DeprecationLevel.Notice); } catch (Exception ex) diff --git a/src/StardewModdingAPI/StardewModdingAPI-settings.json b/src/StardewModdingAPI/StardewModdingAPI-settings.json new file mode 100644 index 00000000..d27d0141 --- /dev/null +++ b/src/StardewModdingAPI/StardewModdingAPI-settings.json @@ -0,0 +1,4 @@ +{ + /* show all deprecation notices in the console? */ + "DeveloperMode": true +} diff --git a/src/StardewModdingAPI/StardewModdingAPI.csproj b/src/StardewModdingAPI/StardewModdingAPI.csproj index 5540267a..bbb41ee3 100644 --- a/src/StardewModdingAPI/StardewModdingAPI.csproj +++ b/src/StardewModdingAPI/StardewModdingAPI.csproj @@ -59,7 +59,7 @@ <UseVSHostingProcess>true</UseVSHostingProcess> <Optimize>false</Optimize> <OutputPath>$(SolutionDir)\..\bin\Debug\SMAPI</OutputPath> - <DocumentationFile>bin\Debug\StardewModdingAPI.xml</DocumentationFile> + <DocumentationFile>$(SolutionDir)\..\bin\Debug\SMAPI\StardewModdingAPI.xml</DocumentationFile> <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow> <LangVersion>6</LangVersion> </PropertyGroup> @@ -68,7 +68,7 @@ <OutputPath>bin\Release\</OutputPath> <Prefer32Bit>false</Prefer32Bit> <OutputPath>$(SolutionDir)\..\bin\Release\SMAPI</OutputPath> - <DocumentationFile>bin\Release\StardewModdingAPI.xml</DocumentationFile> + <DocumentationFile>$(SolutionDir)\..\bin\Debug\SMAPI\StardewModdingAPI.xml</DocumentationFile> <DefineConstants>TRACE</DefineConstants> <Optimize>true</Optimize> <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow> @@ -200,6 +200,7 @@ <Compile Include="Framework\DeprecationManager.cs" /> <Compile Include="Framework\UpdateHelper.cs" /> <Compile Include="Framework\GitRelease.cs" /> + <Compile Include="Framework\UserSettings.cs" /> <Compile Include="Inheritance\ChangeType.cs" /> <Compile Include="Inheritance\ItemStackChange.cs" /> <Compile Include="Log.cs" /> @@ -220,6 +221,9 @@ <None Include="packages.config"> <SubType>Designer</SubType> </None> + <Content Include="StardewModdingAPI-settings.json"> + <CopyToOutputDirectory>Always</CopyToOutputDirectory> + </Content> <None Include="unix-launcher.sh"> <CopyToOutputDirectory>Always</CopyToOutputDirectory> </None> |