summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--docs/release-notes.md3
-rw-r--r--src/SMAPI.Web/Controllers/IndexController.cs7
-rw-r--r--src/SMAPI.Web/StardewModdingAPI.Web.csproj3
-rw-r--r--src/SMAPI.Web/Views/Index/Index.cshtml24
-rw-r--r--src/SMAPI.Web/Views/Index/Privacy.cshtml43
-rw-r--r--src/SMAPI.Web/wwwroot/Content/css/index.css5
-rw-r--r--src/SMAPI.Web/wwwroot/Content/css/privacy.css3
7 files changed, 78 insertions, 10 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 6c2879df..e7434c3c 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -25,9 +25,10 @@
* For the web UI:
* Added a [mod compatibility page](https://mods.smapi.io).
+ * Added [privacy page](https://smapi.io/privacy).
* The log parser now has a separate filter for game messages.
* The log parser now shows content pack authors (thanks to danvolchek!).
- * Corrected log parser instructions for Mac.
+ * Fixed log parser instructions for Mac.
* For modders:
* Added [data API](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Data).
diff --git a/src/SMAPI.Web/Controllers/IndexController.cs b/src/SMAPI.Web/Controllers/IndexController.cs
index dadbedd1..d7be664d 100644
--- a/src/SMAPI.Web/Controllers/IndexController.cs
+++ b/src/SMAPI.Web/Controllers/IndexController.cs
@@ -76,6 +76,13 @@ namespace StardewModdingAPI.Web.Controllers
return this.View(model);
}
+ /// <summary>Display the index page.</summary>
+ [HttpGet("/privacy")]
+ public ViewResult Privacy()
+ {
+ return this.View();
+ }
+
/*********
** Private methods
diff --git a/src/SMAPI.Web/StardewModdingAPI.Web.csproj b/src/SMAPI.Web/StardewModdingAPI.Web.csproj
index 942a4b20..9d1990d9 100644
--- a/src/SMAPI.Web/StardewModdingAPI.Web.csproj
+++ b/src/SMAPI.Web/StardewModdingAPI.Web.csproj
@@ -27,6 +27,9 @@
<ProjectReference Include="..\StardewModdingAPI.Toolkit\StardewModdingAPI.Toolkit.csproj" />
</ItemGroup>
<ItemGroup>
+ <Content Update="Views\Index\Privacy.cshtml">
+ <Pack>$(IncludeRazorContentInPack)</Pack>
+ </Content>
<Content Update="Views\Mods\Index.cshtml">
<Pack>$(IncludeRazorContentInPack)</Pack>
</Content>
diff --git a/src/SMAPI.Web/Views/Index/Index.cshtml b/src/SMAPI.Web/Views/Index/Index.cshtml
index a5a82121..01874f50 100644
--- a/src/SMAPI.Web/Views/Index/Index.cshtml
+++ b/src/SMAPI.Web/Views/Index/Index.cshtml
@@ -1,7 +1,10 @@
+@using Microsoft.Extensions.Options
+@using StardewModdingAPI.Web.Framework.ConfigModels
+@inject IOptions<SiteConfig> SiteConfig
+@model StardewModdingAPI.Web.ViewModels.IndexModel
@{
ViewData["Title"] = "SMAPI";
}
-@model StardewModdingAPI.Web.ViewModels.IndexModel
@section Head {
<link rel="stylesheet" href="~/Content/css/index.css?r=20180615" />
<script src="https://cdn.jsdelivr.net/npm/jquery@3.3.1/dist/jquery.min.js" crossorigin="anonymous"></script>
@@ -16,7 +19,7 @@
<div id="call-to-action">
<div class="cta-dropdown">
- <a href="@Model.StableVersion.DownloadUrl" class="main-cta download">Download SMAPI @Model.StableVersion.Version</a><br/>
+ <a href="@Model.StableVersion.DownloadUrl" class="main-cta download">Download SMAPI @Model.StableVersion.Version</a><br />
<div class="dropdown-content">
<a href="https://www.nexusmods.com/stardewvalley/mods/2400"><img src="Content/images/nexus-icon.png" /> Download from Nexus</a>
<a href="@Model.StableVersion.DownloadUrl"><img src="Content/images/direct-download-icon.png" /> Direct download</a>
@@ -30,22 +33,25 @@
Download SMAPI @Model.BetaVersion.Version
@if (!string.IsNullOrWhiteSpace(Model.BetaBlurb))
{
- <br/><small>@Model.BetaBlurb</small>
+ <br /><small>@Model.BetaBlurb</small>
}
- </a><br/>
+ </a><br />
<div class="dropdown-content">
<a href="https://www.nexusmods.com/stardewvalley/mods/2400"><img src="Content/images/nexus-icon.png" /> Download from Nexus</a>
<a href="@Model.BetaVersion.DownloadUrl"><img src="Content/images/direct-download-icon.png" /> Direct download</a>
</div>
</div><br />
}
- <a href="https://stardewvalleywiki.com/Modding:Player_Guide" class="secondary-cta">Player guide</a><br />
+ <div><a href="https://stardewvalleywiki.com/Modding:Player_Guide" class="secondary-cta">Player guide</a></div>
+ <div class="sublinks">
+ <a href="https://github.com/Pathoschild/SMAPI">source code</a> | <a href="@(new UriBuilder(SiteConfig.Value.RootUrl) { Path = "privacy" }.Uri)">privacy</a>
+ </div>
<img id="pufferchick" src="Content/images/pufferchick.png" />
</div>
<h2 id="help">Get help</h2>
<ul>
- <li><a href="https://stardewvalleywiki.com/Modding:SMAPI_compatibility">Mod compatibility list</a></li>
+ <li><a href="@SiteConfig.Value.ModListUrl">Mod compatibility list</a></li>
<li>Get help <a href="https://stardewvalleywiki.com/Modding:Community#Discord">on Discord</a> or <a href="https://community.playstarbound.com/threads/smapi-stardew-modding-api.108375/">in the forums</a></li>
</ul>
@@ -55,7 +61,7 @@
<div class="github-description">
@Html.Raw(Markdig.Markdown.ToHtml(Model.StableVersion.Description))
</div>
- <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="https://stardewvalleywiki.com/Modding:SMAPI_compatibility">mod compatibility list</a> for more info.</p>
+ <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="@SiteConfig.Value.ModListUrl">mod compatibility list</a> for more info.</p>
}
else
{
@@ -64,13 +70,13 @@ else
<div class="github-description">
@Html.Raw(Markdig.Markdown.ToHtml(Model.StableVersion.Description))
</div>
- <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="https://stardewvalleywiki.com/Modding:SMAPI_compatibility">mod compatibility list</a> for more info.</p>
+ <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="@SiteConfig.Value.ModListUrl">mod compatibility list</a> for more info.</p>
<h3>SMAPI @Model.BetaVersion.Version?</h3>
<div class="github-description">
@Html.Raw(Markdig.Markdown.ToHtml(Model.BetaVersion.Description))
</div>
- <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="https://stardewvalleywiki.com/Modding:SMAPI_compatibility">mod compatibility list</a> for more info.</p>
+ <p>See the <a href="https://github.com/Pathoschild/SMAPI/blob/develop/docs/release-notes.md#release-notes">release notes</a> and <a href="@SiteConfig.Value.ModListUrl">mod compatibility list</a> for more info.</p>
}
<h2 id="donate">Donate to support SMAPI ♥</h2>
diff --git a/src/SMAPI.Web/Views/Index/Privacy.cshtml b/src/SMAPI.Web/Views/Index/Privacy.cshtml
new file mode 100644
index 00000000..ca99eef6
--- /dev/null
+++ b/src/SMAPI.Web/Views/Index/Privacy.cshtml
@@ -0,0 +1,43 @@
+@using Microsoft.Extensions.Options
+@using StardewModdingAPI.Web.Framework.ConfigModels
+@inject IOptions<SiteConfig> SiteConfig
+@{
+ ViewData["Title"] = "SMAPI privacy notes";
+}
+@section Head {
+ <link rel="stylesheet" href="~/Content/css/privacy.css" />
+}
+
+&larr; <a href="@SiteConfig.Value.RootUrl">back to SMAPI page</a>
+
+<p>SMAPI is an <a href="https://github.com/Pathoschild/SMAPI">open-source</a> and non-profit project. Your privacy is important, so this page explains what information SMAPI uses and transmits. <strong>This page is informational only, it's not a legal document.</strong></p>
+
+<h2>Principles</h2>
+<ol>
+ <li>SMAPI collects the minimum information needed to enable its features (see below).</li>
+ <li>SMAPI does not collect telemetry, analytics, etc.</li>
+ <li>SMAPI will never sell your information.</li>
+</ol>
+
+<h2>Data collected and transmitted</h2>
+<h3 id="web-logging">Web logging</h3>
+<p>This website and SMAPI's web API are hosted by Amazon Web Services. Their servers may automatically collect diagnostics like your IP address, but this information is not visible to SMAPI's web application or developers. For more information, see the <a href="https://aws.amazon.com/privacy/">Amazon Privacy Notice</a>.</p>
+
+<h3>Update checks</h3>
+<p>SMAPI notifies you when there's a new version of SMAPI or your mods available. To do so, it sends your SMAPI and mod versions to its web API. No personal information is stored by the web application, but see <em><a href="#web-logging">web logging</a></em>.</p>
+
+<p>You can disable update checks, and no information will be transmitted to the web API. To do so:</p>
+<ol>
+ <li><a href="https://stardewvalleywiki.com/Modding:Game_folder">find your game folder</a>;</li>
+ <li>open the <code>smapi-internal/StardewModdingAPI.config.json</code> file in a text editor;</li>
+ <li>change <code>"CheckForUpdates": true</code> to <code>"CheckForUpdates": false</code>.</li>
+</ol>
+
+<h3>Log parser</h3>
+<p>The <a href="https://log.smapi.io/">log parser page</a> lets you store a log file for analysis and sharing. The log data is stored indefinitely in an obfuscated form as unlisted pastes in <a href="https://pastebin.com/">Pastebin</a>. No personal information is stored by the log parser beyond what you choose to upload, but see <em><a href="#web-logging">web logging</a></em> and the <a href="https://pastebin.com/doc_privacy_statement">Pastebin Privacy Statement</a>.</p>
+
+<h3>Multiplayer sync</h3>
+<p>As part of its multiplayer API, SMAPI transmits basic context to players you connect to (mainly your OS, SMAPI version, game version, and installed mods). This is used to enable multiplayer features like inter-mod messages, compatibility checks, etc. Although this information is normally hidden from players, it may be visible due to mods or configuration changes.</p>
+
+<h3>Custom mods</h3>
+<p><strong>Mods may collect and transmit any information. Mods (except those provided as part of the SMAPI download) are not covered by this page. Install third-party mods at your own risk.</strong></p>
diff --git a/src/SMAPI.Web/wwwroot/Content/css/index.css b/src/SMAPI.Web/wwwroot/Content/css/index.css
index 514e1a5c..979af4af 100644
--- a/src/SMAPI.Web/wwwroot/Content/css/index.css
+++ b/src/SMAPI.Web/wwwroot/Content/css/index.css
@@ -93,6 +93,11 @@ h1 {
display: block;
}
+.sublinks {
+ font-size: 0.9em;
+ margin-bottom: 1em;
+}
+
/*********
** Subsections
*********/
diff --git a/src/SMAPI.Web/wwwroot/Content/css/privacy.css b/src/SMAPI.Web/wwwroot/Content/css/privacy.css
new file mode 100644
index 00000000..94bc68a9
--- /dev/null
+++ b/src/SMAPI.Web/wwwroot/Content/css/privacy.css
@@ -0,0 +1,3 @@
+h3 {
+ border: 0;
+}
generated by cgit (git 2.46.0) at 2024-11-27 06:07:27 +0000