NAV

Overview

7 Days to Die Blockstorm Hide & Hold Out Hurtworld Reign of Kings Rust Rust Legacy Space Enegineers Terraria The Forest Unturned

Oxide is 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.

Plugins can currently be developed for the games 7 Days to Die, Blockstorm, Hide & Hold Out, Hurtworld, Reign of Kings, Rust, Rust Legacy, Space Engineeers, Terraria, The Forest, and Unturned, with support for more on the way!

Oxide provides support for multiple programming languages to develop plugins: C# (CSharp), Lua, CoffeeScript, JavaScript, and Python. Make them as complicated or as simple as you’d like, your imagination is the limit!

Database support for plugins is also available in the MySQL and SQLite varieties, so if JSON files aren’t enough, you have options! If you’d prefer another database type, those can always be accessed via web requests and your own custom bridge script on your site.

Supported Games

7 Days to Die

Oxide support for 7 Days to Die is currently limited, and in an alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Blockstorm

Oxide support for Blockstorm is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Hide & Hold Out

Oxide support for Hide & Hold Out is actively developed, but in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Hurtworld

Oxide support for Hurtworld is actively developed, but in an alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Reign of Kings

Oxide support for Reign of Kings is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Rust

Oxide support for Rust (formerly Rust Experimental) is actively developed. This is the version of Rust supported by the Facepunch developers.

Homepage | Steam Page | API documentation

Rust Legacy

Oxide support for Rust Legacy is mostly complete, but it may receive fixes as needed. The game itself has been discontinued by the developers though. You can access this version of Rust by using the -beta legacy command-line parameter with SteamCMD.

Homepage | Steam Page | API documentation

Space Engineers

Oxide support for Space Engineers is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Terraria

Oxide support for Terraria is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

The Forest

Oxide support for The Forest is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Unturned

Oxide support for Unturned is currently limited, and in a very alpha state. More hooks will be added soon.

Homepage | Steam Page | API documentation

Getting Help

Contributing

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/OxideMod/Oxide.git (recommended) or download and extract the latest zip archive.

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

  4. Open the Oxide.sln solution file in Visual Studio 2015.

  5. Build the solution. If you get errors, you’re likely not using the latest Visual Studio 2015 which is required as Oxide uses some C# 6.0 features.

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