Skip to content

Repository files navigation

Template for Rust (Oxide)

What this is

Barebones template for building Harmony mods and Oxide plugins for the game Rust. Ships with two sample projects:

  • Mod for a Harmony mod you can compile (Latest C#)
  • Plugins for Oxide plugins (C# 11)

Prerequisites

  • .NET for the latest DepotDownloader release. Usually already present if you are a developer or if you are using GitHub runners.
  • Modern PowerShell. Usually already present if you are using GitHub runners.

Updating

Run Update.PS1 to download the most recent Rust and Oxide files. Examples:

# PowerShell
Unblock-File ./Update.PS1 # Required on Windows (once)
./Update.PS1 -Clean 1
# Other shells
pwsh -Command "Unblock-File ./Update.PS1" # Required on Windows (once)
pwsh -Command "& ./Update.PS1 -Clean 1"
Parameter Description
-OS <Windows/Linux> The OS for which to download the files
-Clean <1/0> Cleans folders of tools and dependencies when 1
-Staging <1/0> Downloads staging version of Rust and Oxide when 1

About

Barebones template for building Harmony mods and Oxide plugins for the game Rust.

Resources

Stars

Watchers

Forks

Used by

Contributors

Languages