diametric / umod.rust

Rust game extension for the uMod modding framework

uMod

A complete rewrite of the popular, original Oxide API and Lua plugin framework. Previously only available for the legacy Rust game, uMod now supports numerous games. uMod's focus is on modularity and extensibility. The core is highly abstracted and loosely coupled, and could be used to mod any game that uses the .NET Framework.

Support for each game and plugin language is added via extensions. When loading, uMod scans the binary folder for DLL extensions with the format uMod.*.dll.

Bundled Extensions

• uMod.MySql - Allows plugins to access a MySQL database
• uMod.SQLite - Allows plugins to access a SQLite database
• uMod.Unity - Provides support for Unity powered games
• uMod.Rust - Provides support for the new Rust server

Open Source

uMod is free, open source software distributed under the MIT License. We accept and encourage contributions from our community, and sometimes give cookies in return.

Compiling Source

While we recommend using one of the official release builds, you can compile your own builds if you'd like. Keep in mind that only official builds are supported by the uMod team and community. Good luck!

1. Download a Git client such as GitHub Desktop or SourceTree.

2. Clone the repo https://github.com/theumod/umod.Rust.git (recommended) or download and extract the latest zip archive.

3. Download and install Visual Studio 2017 (community is free, but any edition will work) if you do not have it installed already.

4. Update or install PowerShell 5.x (if it isn't already) for use with the game file downloading and patching process.

5. Open the uMod.sln solution file in Visual Studio 2017.

6. Build the solution. If you get errors, you're likely not using the latest Visual Studio 2017; which is required as uMod uses some C# 6.0 features.

7. Copy the files from the Bundles directory for your game of choice to your server installation, then just start the server!

7a. Alternately, create a .deploy file in the project's root directory with a path to automatically deploy to.

Getting Help

• The best place to start with plugin development is the official API documentation.
• Still need help? Search our community forums or create a new thread if needed.

Contributing

• Got an idea or suggestion? Use the community forums to share and discuss it.
• Troubleshoot issues you run into on the community forums so everyone can help and reference it later.
• File detailed issues on GitHub (version number, what you did, and actual vs. expected outcomes).
• Want uMod and plugins for your favorite game? Hook us up and we'll see what we can do!

Reporting Security Issues

Please disclose security issues responsibly by emailing [email protected] with a full description. We'll work on releasing an updated version as quickly as possible. Please do not email non-security issues; use the forums or issue tracker instead.