Skip to content

Commit b45ed63

Browse files
sunnamed434claude
andcommitted
docs: note RocketModFix.LDM.Redist as an official-Rocket alternative
Document the new official upstream Rocket (LDM) redist alongside the RocketModFix fork: a "which Rocket package?" section in the README and a commented swap-in PackageReference in both example csproj. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 84f8a2d commit b45ed63

3 files changed

Lines changed: 27 additions & 3 deletions

File tree

Publicized/UnturnedRedistExample.Publicized.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88
</PropertyGroup>
99

1010
<ItemGroup>
11-
<!-- RocketMod API. Brings Rocket.Core (RocketPlugin, Logger) + Rocket.API. -->
11+
<!-- RocketMod API. Brings Rocket.Core (RocketPlugin, Logger) + Rocket.API.
12+
This is the RocketModFix fork; for official upstream Rocket, swap it for
13+
the LDM redist below (use one or the other, never both). -->
1214
<PackageReference Include="RocketModFix.Rocket.Unturned" Version="4.23.1" />
15+
<!-- <PackageReference Include="RocketModFix.LDM.Redist" Version="4.9.3.18" /> -->
1316

1417
<!-- Publicized: Unturned's assemblies with non-public members rewritten to
1518
public, so this plugin can read them directly. Pinned to the SAME game

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,30 @@ The one requirement: set `<AllowUnsafeBlocks>true</AllowUnsafeBlocks>` in the `.
5050

5151
| Package | Why |
5252
| --- | --- |
53-
| [`RocketModFix.Rocket.Unturned`](https://www.nuget.org/packages/RocketModFix.Rocket.Unturned) | RocketMod API — the `RocketPlugin` base class and `Logger`. |
53+
| [`RocketModFix.Rocket.Unturned`](https://www.nuget.org/packages/RocketModFix.Rocket.Unturned) | RocketMod API — the `RocketPlugin` base class and `Logger`. *(Or swap in [`RocketModFix.LDM.Redist`](https://github.com/RocketModFix/RocketModFix.LDM.Redist) for **official upstream** Rocket — see [below](#official-rocket-ldm-or-the-rocketmodfix-fork).)* |
5454
| [`RocketModFix.Unturned.Redist.Server`](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server) / [`.Publicized`](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server.Publicized) | Unturned's server assemblies. `.Publicized` additionally exposes non-public members. |
5555
| [`RocketModFix.UnityEngine.Redist`](https://www.nuget.org/packages/RocketModFix.UnityEngine.Redist) | UnityEngine assemblies — required because Unturned types derive from `UnityEngine.MonoBehaviour`. |
5656

5757
See the [redist README](https://github.com/RocketModFix/RocketModFix.Unturned.Redist#using-a-publicized-package) for more on `.Publicized` and `AllowUnsafeBlocks`.
5858

59+
## Official Rocket (LDM) or the RocketModFix fork?
60+
61+
The `RocketPlugin` / `Logger` API can come from **either** of two packages — pick one (don't reference both; they ship the same `Rocket.*` assemblies):
62+
63+
| Package | What it is |
64+
| --- | --- |
65+
| [`RocketModFix.Rocket.Unturned`](https://www.nuget.org/packages/RocketModFix.Rocket.Unturned) | The **RocketModFix fork** of Rocket — same API, plus bug fixes and features. Versioned like the fork (e.g. `4.23.1`). Used by both example projects above. |
66+
| [`RocketModFix.LDM.Redist`](https://github.com/RocketModFix/RocketModFix.LDM.Redist) | The **official upstream** Rocket — SDG's [Legally Distinct Missile][ldm], redistributed as-is. Zero-dependency (pair it with any Unturned redist). Versioned by Rocket's own version (e.g. `4.9.3.18`). |
67+
68+
Both expose the same `Rocket.API` / `Rocket.Core` / `Rocket.Unturned` types, so switching is a one-line change in the `.csproj`:
69+
70+
```xml
71+
<!-- Official upstream Rocket (LDM) instead of the RocketModFix fork: -->
72+
<PackageReference Include="RocketModFix.LDM.Redist" Version="4.9.3.18" />
73+
```
74+
75+
[ldm]: https://github.com/SmartlyDressedGames/Legally-Distinct-Missile
76+
5977
## Build
6078

6179
```bash

Reflection/UnturnedRedistExample.Reflection.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<!-- RocketMod API. Brings Rocket.Core (RocketPlugin, Logger) + Rocket.API. -->
10+
<!-- RocketMod API. Brings Rocket.Core (RocketPlugin, Logger) + Rocket.API.
11+
This is the RocketModFix fork; for official upstream Rocket, swap it for
12+
the LDM redist below (use one or the other, never both). -->
1113
<PackageReference Include="RocketModFix.Rocket.Unturned" Version="4.23.1" />
14+
<!-- <PackageReference Include="RocketModFix.LDM.Redist" Version="4.9.3.18" /> -->
1215

1316
<!-- Plain (non-publicized) redist: non-public members aren't exposed, so this
1417
project reaches isDedicatedUGCInstalled via reflection. Pinned to the SAME

0 commit comments

Comments
 (0)