Oxide Mod

A complete rewrite of the popular, original Oxide API and Lua plugin framework. Previously only available for the legacy Rust game, Oxide now supports numerous games. Oxide'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, Oxide scans the binary folder for DLL extensions with the format Oxide.*.dll.

Bundled Extensions

• Oxide.CSharp - Allows plugins written in CSharp to be loaded Currently not supported because the game uses .net 2.0 subset.
• Oxide.MySql - Allows plugins to access a MySQL database
• Oxide.SQLite - Allows plugins to access a SQLite database
• Oxide.Unity - Provides support for Unity powered games
• Oxide.GettingOverIt - Provides support for the Getting Over It with Bennett Foddy game

Open Source

Oxide 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 Oxide team and community. Good luck!

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

2. Clone the repo https://github.com/Skippeh/Oxide.GettingOverIt.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 Oxide.GettingOverIt.sln solution file in Visual Studio 2017.

6. Create a directory called tools, then a file named .steamlogin. Write a steam username and password that has access to the game. Alternatively copy and paste your locally installed game files into src\Dependencies\Patched\GettingOverIt_Data\Managed.

7. Build the solution. If you get errors, you're likely not using the latest Visual Studio 2017; which is required as Oxide uses some C# 6.0 features. You can ignore steam related errors if you don't have a .steamlogin file and copied your local game files.

8. Copy the files from the Bundles directory to the root of your installation folder, then just start the game!

8a. Alternately, create a .deploy file under the desired game extension directory (ie. Games/Oxide.Rust) with a path to automatically deploy to.

Getting Help

• There is currently no documentation for this extension. You will have to look through the source code for now. TestPlugin.cs

Contributing

• File detailed issues on GitHub (version number, what you did, and actual vs expected outcomes).