feat: example plugin for the Unturned Redist .Publicized package

Minimal RocketMod plugin (UnturnedRedistExample) that references the
RocketModFix Rocket + Unturned/UnityEngine redist packages and, on load,
reads a non-public Unturned field (Provider.isDedicatedUGCInstalled) via the
.Publicized redist — proving publicized access compiles and runs. Includes a
build CI workflow and Dependabot (NuGet + GitHub Actions).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Author: sunnamed434

.github/dependabot.yml

@@ -0,0 +1,43 @@
+version: 2
+updates:
+  # GitHub Actions used by the build workflow.
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+      timezone: "UTC"
+    open-pull-requests-limit: 10
+    reviewers:
+      - "@me"
+    assignees:
+      - "@me"
+    commit-message:
+      prefix: "deps"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "github-actions"
+
+  # NuGet packages referenced by the plugin (RocketMod + redist).
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+      timezone: "UTC"
+    open-pull-requests-limit: 10
+    reviewers:
+      - "@me"
+    assignees:
+      - "@me"
+    commit-message:
+      prefix: "deps"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "nuget"
+    allow:
+      - dependency-type: "direct"

.github/workflows/build.yaml

@@ -0,0 +1,24 @@
+name: Build
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '8.0.x'
+
+      # Proves the plugin compiles against the .Publicized redist.
+      - name: Build
+        run: dotnet build -c Release
+
+      - name: Upload plugin DLL
+        uses: actions/upload-artifact@v4
+        with:
+          name: UnturnedRedistExample
+          path: bin/Release/net461/UnturnedRedistExample.dll
+          if-no-files-found: error

.gitignore

@@ -0,0 +1,4 @@
+bin/
+obj/
+*.user
+.vs/

README.md

@@ -1,2 +1,57 @@
 # RocketModFix.Unturned.Redist.Example
 
+A minimal [RocketMod](https://github.com/RocketModFix/RocketModFix) plugin showing how to consume the RocketModFix NuGet packages in an Unturned server plugin — in particular the [`RocketModFix.Unturned.Redist`](https://github.com/RocketModFix/RocketModFix.Unturned.Redist) **`.Publicized`** package, which lets a plugin read members that are non-public in the stock game.
+
+> This is an example **consumer** plugin. Its own namespace is `UnturnedRedistExample` — i.e. what *you'd* write in your own plugin — it just **references** the RocketModFix packages.
+
+## What it demonstrates
+
+[`UnturnedRedistExamplePlugin.cs`](UnturnedRedistExamplePlugin.cs) is one class. On load it reads `SDG.Unturned.Provider.isDedicatedUGCInstalled` — a field that is **non-public** in the stock `Assembly-CSharp.dll` — and logs it:
+
+```csharp
+protected override void Load()
+{
+    // non-public in stock Unturned; reachable only via the .Publicized redist
+    var ugcInstalled = Provider.isDedicatedUGCInstalled;
+    Logger.Log($"[UnturnedRedistExample] Loaded. ... = {ugcInstalled} ...");
+}
+```
+
+That single line is the whole point:
+
+- It **compiles** only because the project references `RocketModFix.Unturned.Redist.Server.Publicized` (the publicizer rewrites that field to public).
+- It **runs** only because the `.csproj` sets `<AllowUnsafeBlocks>true</AllowUnsafeBlocks>`, which lets Unturned's Mono runtime skip the access check.
+
+## Packages used
+
+| Package | Why |
+| --- | --- |
+| [`RocketModFix.Rocket.Unturned`](https://www.nuget.org/packages/RocketModFix.Rocket.Unturned) | The RocketMod API — provides the `RocketPlugin` base class and `Logger`. |
+| [`RocketModFix.Unturned.Redist.Server.Publicized`](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server.Publicized) | Unturned's server assemblies, **publicized** so the plugin can touch non-public members. Use [`…Server`](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server) (without `.Publicized`) if you don't need that. |
+| [`RocketModFix.UnityEngine.Redist`](https://www.nuget.org/packages/RocketModFix.UnityEngine.Redist) | UnityEngine assemblies — required because Unturned types derive from `UnityEngine.MonoBehaviour`. |
+
+See the [redist README](https://github.com/RocketModFix/RocketModFix.Unturned.Redist#using-a-publicized-package) for more on `.Publicized` and `AllowUnsafeBlocks`.
+
+## Build
+
+```bash
+dotnet build -c Release
+```
+
+The plugin DLL lands in `bin/Release/net461/UnturnedRedistExample.dll`. CI builds it on every push — see [`.github/workflows/build.yaml`](.github/workflows/build.yaml).
+
+## Verify it loads on a server
+
+1. Install [RocketModFix](https://github.com/RocketModFix/RocketModFix#installation) on an Unturned dedicated server (copy the `Rocket.Unturned` folder into `Modules/`) and start it once so it generates `Servers/<ServerID>/Rocket/`.
+2. Copy the built `UnturnedRedistExample.dll` into `Servers/<ServerID>/Rocket/Plugins/` (the DLL goes directly in `Plugins/`, not a subfolder).
+3. Start the server and watch the console for:
+
+   ```
+   [UnturnedRedistExample] Loaded. Read non-public Provider.isDedicatedUGCInstalled = ... via the .Publicized redist.
+   ```
+
+That line confirms two things at once: the plugin **loaded**, and the **publicized** member was read successfully **at runtime** (so `AllowUnsafeBlocks` did its job). If publicization were broken you'd instead get a `FieldAccessException` / "is inaccessible" error.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

UnturnedRedistExample.csproj

@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net461</TargetFramework>
+    <!-- Required by any .Publicized redist: lets Mono skip the runtime access
+         check on the originally-private members. See README. -->
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- RocketMod API. Brings Rocket.Core (RocketPlugin, Logger) + Rocket.API. -->
+    <PackageReference Include="RocketModFix.Rocket.Unturned" Version="4.23.1" />
+
+    <!-- Unturned's managed assemblies, publicized so the plugin can read
+         non-public members. Floats to the latest stable build (the redist
+         auto-updates each game patch); pin a version if you want reproducibility. -->
+    <PackageReference Include="RocketModFix.Unturned.Redist.Server.Publicized" Version="3.*" />
+
+    <!-- UnityEngine assemblies. Needed because Unturned types (e.g. Provider)
+         derive from UnityEngine.MonoBehaviour. -->
+    <PackageReference Include="RocketModFix.UnityEngine.Redist" Version="2022.3.*" />
+
+    <!-- Lets `net461` build on Linux/macOS CI without a Windows targeting pack. -->
+    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.3" PrivateAssets="all" />
+  </ItemGroup>
+
+</Project>

UnturnedRedistExamplePlugin.cs

@@ -0,0 +1,37 @@
+using Rocket.Core.Logging;
+using Rocket.Core.Plugins;
+using SDG.Unturned;
+
+namespace UnturnedRedistExample
+{
+    /// <summary>
+    /// Minimal RocketMod plugin that demonstrates consuming the
+    /// <c>RocketModFix.Unturned.Redist.Server.Publicized</c> NuGet package.
+    ///
+    /// On load it reads <see cref="Provider.isDedicatedUGCInstalled"/> — a field
+    /// that is non-public in the stock <c>Assembly-CSharp.dll</c>. That line only
+    /// compiles because we reference the <c>.Publicized</c> redist (which rewrites
+    /// the field to public), and only runs because the .csproj sets
+    /// <c>AllowUnsafeBlocks</c> (which lets Mono skip the runtime access check).
+    /// Seeing the log line in the server console is end-to-end proof that
+    /// publicized access works.
+    /// </summary>
+    public class UnturnedRedistExamplePlugin : RocketPlugin
+    {
+        protected override void Load()
+        {
+            // isDedicatedUGCInstalled is non-public in stock Unturned — reachable
+            // here only through the .Publicized redist.
+            var ugcInstalled = Provider.isDedicatedUGCInstalled;
+
+            Logger.Log(
+                $"[UnturnedRedistExample] Loaded. Read non-public " +
+                $"Provider.isDedicatedUGCInstalled = {ugcInstalled} via the .Publicized redist.");
+        }
+
+        protected override void Unload()
+        {
+            Logger.Log("[UnturnedRedistExample] Unloaded.");
+        }
+    }
+}