NAV Navbar
  • Overview
  • Supported Games
  • Getting Help
  • Contributing
  • Compiling Source
  • Overview

    7 Days to Die Blockstorm Hurtworld Reign of Kings Rust Rust Legacy 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 in C# (CSharp) for the games 7 Days to Die, Blockstorm, Hurtworld, Reign of Kings, Rust, Rust Legacy, The Forest, and Unturned, with support for more on the way!

    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

    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.

    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 (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. Open the .sln solution file in Visual Studio 2017.

    5. Build the solution. If you get errors, you're likely not using the latest Visual Studio 2017 which is required as Oxide projects use some C# 6.0 features and use the new .csproj format.

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