Skip to content

Commit dc9f120

Browse files
committed
Update README.md
1 parent b918d2c commit dc9f120

File tree

1 file changed

+43
-23
lines changed

1 file changed

+43
-23
lines changed

README.md

Lines changed: 43 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,58 @@
22

33
## Why Use This?
44

5-
Do you find it annoying to copy libraries from the Managed directory every time Unturned updates? With this NuGet package, you get all the necessary libraries for Unturned, and they update automatically. You don't need to wait for us to update them manually. This package is like a "redistributable" that stays current.
5+
Do you find it annoying to manually copy libraries from the Managed directory every time Unturned updates? With this NuGet package, you get all the necessary Unturned libraries, and they update automatically. You don't need to wait for manual updates — this package acts like a redistributable that stays current.
66

77
You get:
88

9-
- **Assembly-CSharp.dll**
10-
- **com.rlabrecque.steamworks.net.dll**
11-
- **UnturnedDat.dll**
12-
- and many more, including XML docs for the Unturned API and more.
9+
- **Assembly-CSharp.dll**
10+
- **com.rlabrecque.steamworks.net.dll**
11+
- **UnturnedDat.dll**
12+
- And many more, including XML docs for the Unturned API and related dependencies.
13+
14+
---
15+
16+
## Available Packages and What They Mean
17+
18+
| Package Name | Description |
19+
|-----------------------------------------------|------------------------------------------------|
20+
| **RocketModFix.Unturned.Redist.Client** | Libraries for Unturned client-side tools. |
21+
| **RocketModFix.Unturned.Redist.Server** | Libraries for Unturned server-side tools. |
22+
| **RocketModFix.Unturned.Redist.Client.Publicized** | Publicized client-side libraries with public method/property (members) visibility for modding or advanced reflection. |
23+
| **RocketModFix.Unturned.Redist.Server.Publicized** | Publicized server-side libraries with public method/property (members) visibility. Useful for plugins needing deeper access. |
24+
| **RocketModFix.Unturned.Redist.Client-Preview** | Early access (preview) versions of client-side libraries. |
25+
| **RocketModFix.Unturned.Redist.Server-Preview** | Early access (preview) versions of server-side libraries. |
26+
27+
> **Note:** The main `Client` and `Server` packages now include preview (prerelease) versions inside them for simplicity. The `*-Preview` packages remain available for backward compatibility.
28+
29+
---
1330

1431
## How to Install
1532

16-
These libraries (or "redists") update by themselves, so you don’t have to worry about manual updates.
33+
Simply pick the package that matches your needs and add it via NuGet. For example, in your `.csproj` or `packages.config`:
34+
35+
```xml
36+
<PackageReference Include="RocketModFix.Unturned.Redist.Server" Version="x.y.z" />
37+
```
1738

18-
Choose the package that fits your need:
39+
Or use the NuGet CLI:
1940

20-
- **RocketModFix.Unturned.Redist.Client:** For tools that run on the Unturned client.
21-
- **RocketModFix.Unturned.Redist.Server:** For tools that run on the Unturned server.
22-
- **RocketModFix.Unturned.Redist.Client-Preview:** For early versions of the client-side libraries.
23-
- **RocketModFix.Unturned.Redist.Server-Preview:** For early versions of the server-side libraries.
41+
```bash
42+
dotnet add package RocketModFix.Unturned.Redist.Server
43+
```
2444

25-
### Installation Links
45+
---
2646

27-
Click the links below to get the package you need:
47+
## Installation Links
2848

29-
[![RocketModFix.Unturned.Redist.Client](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Client?label=RocketModFix.Unturned.Redist.Client&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FRocketModFix.Unturned.Redist.Client)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Client)
30-
[![RocketModFix.Unturned.Redist.Server](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Server?label=RocketModFix.Unturned.Redist.Server&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FRocketModFix.Unturned.Redist.Server)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server)
31-
[![RocketModFix.Unturned.Redist.Client-Preview](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Client-Preview?label=RocketModFix.Unturned.Redist.Client-Preview&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FRocketModFix.Unturned.Redist.Client-Preview)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Client-Preview)
32-
[![RocketModFix.Unturned.Redist.Server-Preview](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Server-Preview?label=RocketModFix.Unturned.Redist.Server-Preview&link=https%3A%2F%2Fwww.nuget.org%2Fpackages%2FRocketModFix.Unturned.Redist.Server-Preview)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server-Preview)
49+
[![Client](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Client?label=RocketModFix.Unturned.Redist.Client)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Client)
50+
[![Server](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Server?label=RocketModFix.Unturned.Redist.Server)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server)
51+
[![Client Preview](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Client-Preview?label=RocketModFix.Unturned.Redist.Client-Preview)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Client-Preview)
52+
[![Server Preview](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Server-Preview?label=RocketModFix.Unturned.Redist.Server-Preview)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server-Preview)
53+
[![Client Publicized](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Client.Publicized?label=RocketModFix.Unturned.Redist.Client.Publicized)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Client.Publicized)
54+
[![Server Publicized](https://img.shields.io/nuget/v/RocketModFix.Unturned.Redist.Server.Publicized?label=RocketModFix.Unturned.Redist.Server.Publicized)](https://www.nuget.org/packages/RocketModFix.Unturned.Redist.Server.Publicized)
3355

34-
> **Note:**
35-
> The main `RocketModFix.Unturned.Redist.Client` and `RocketModFix.Unturned.Redist.Server` packages now also include **preview (prerelease)** versions. These are the same as `RocketModFix.Unturned.Redist.Client-Preview` and `Server-Preview`, just under the main package name.
36-
>
37-
> This is mainly to simplify things going forward. The older `*-Preview` packages are still supported for backward compatibility, so you don't need to switch if you're already using them.
56+
---
3857

3958
## Architecture
4059

@@ -43,10 +62,11 @@ We don't run any of this on external servers — everything happens directly on
4362

4463
![Architecture](https://raw.githubusercontent.com/RocketModFix/RocketModFix.Unturned.Redist/master/architecture.jpg)
4564

65+
---
66+
4667
## Credits
4768

4869
Special thanks to these projects that helped us build this auto-updating tool:
4970

50-
- [Unturned-Datamining](https://github.com/Unturned-Datamining)
51-
71+
- [Unturned-Datamining](https://github.com/Unturned-Datamining)
5272
- [setup-steamcmd](https://github.com/CyberAndrii/setup-steamcmd)

0 commit comments

Comments
 (0)