Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.76 KB

README.md

File metadata and controls

46 lines (32 loc) · 2.76 KB


Carbon is a self-updating, lightweight, intelligent mod loader for Rust utilizing the latest C# and Harmony for the best performance and stability possible. Its robust framework and backward compatibility with Oxide plugins make it the ultimate replacement for those wanting better functionality and performance from their plugins!

Carbon has all the creature comforts you need to run your server, such as a permission system, user system, and so much more. Carbon is developed by experienced developers and server owners working to take the tedium out of hosting servers and make configuration and setup seamless with an integrated GUI in-game to manage everything!

How to Submit

This project is open for PR requests. Publishing Harmony patches and hooks will go through a few validation tests before released as a Community hook update on production servers.

To get started, fork this repository, make your changes following the pattern (and generating a GUID using this for the hook identification), commit, then we'll take it from there. Please make sure to add documentation attributes, using the following whenever applicable:

  1. [MetadataAttribute.Info("This hook does this and that.")] - allowed multiple.
  2. [MetadataAttribute.Parameter("parameterName", typeof(ParameterType))] - allowed multiple.
  3. [MetadataAttribute.Return(typeof(ReturnType))] - optional. Don't add this if your hook is a void call.

📦 Download

Start using Carbon today, download the latest version from our releases page. We also provide a quick start script to get your server running in minutes, available for Windows and Linux.

📘 Documentation

For more in-depth Carbon documentation, from builds and deployment, check here. Find all currently available hooks here. If you are a developer take a look at our Wiki page.

❓ Support

Join our official Discord server for support, more frequent development info, discussions and future plans.

❤️ Sponsor

If you would like to sponsor the project the best way is to use Patreon.

We would like to thank everyone who sponsors us.