Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 4.99 KB

README.md

File metadata and controls

70 lines (48 loc) · 4.99 KB
Raw

Oxide Mod License Build Status

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. Extension filenames are formatted as Oxide.Ext.Name.dll or Oxide.Game.Name.dll.

Official Core Extensions

  • Oxide.Ext.CSharp - Allows plugins written in CSharp to be loaded
  • Oxide.Ext.JavaScript - Allows plugins written in JavaScript to be loaded
  • Oxide.Ext.Lua - Allows plugins written in Lua to be loaded
  • Oxide.Ext.MySql - Allows plugins to access a MySQL database
  • Oxide.Ext.Python - Allows plugins written in Python to be loaded
  • Oxide.Ext.SQLite - Allows plugins to access a SQLite database
  • Oxide.Ext.Unity - Provides support for Unity powered games

Supported Game Extensions

  • Oxide.Game.Blockstorm - Provides support for the Blockstorm server
  • Oxide.Game.HideHoldOut - Provides support for the Hide & Hold Out server
  • Oxide.Game.Hurtworld - Provides support for the Hurtworld server
  • Oxide.Game.Nomad - Provides support for the Nomad server
  • Oxide.Game.ReignOfKings - Provides support for the Reign of Kings server
  • Oxide.Game.Rust - Provides support for the new Rust server
  • Oxide.Game.RustLegacy - Provides support for the old Rust Legacy server
  • Oxide.Game.SevenDays - Provides support for the 7 Days to Die server
  • Oxide.Game.Terraria - Provides support for the Terraria server
  • Oxide.Game.TheForest - Provides support for The Forest server
  • Oxide.Game.Unturned - Provides support for the Unturned server

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/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!

Getting Help

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