uMod Documentation

uMod (formerly known as Oxide) is a modding framework for Unity games. It provides a robust platform for server-side modifications.

Key Features

  • Extensibility: Easily extend the game’s functionality with custom mods.
  • Performance: Optimized for high performance and low overhead.
  • Compatibility: Works with numerous Unity-based games.

Installation

  1. Download the latest release from the uMod website.
  2. Unzip the files into your game’s server directory.
  3. Start your server, and uMod will load automatically.

Usage

Once installed, you can create and install plugins:

Creating a Plugin

To create a plugin:

  1. Use the provided template in the Plugins folder.
  2. Follow the programming guidelines in the documentation.

Installing Plugins

  • Place the plugin files in the Plugins directory of your server.
  • Reload your server to activate the new mods.

API Reference

The uMod API allows developers to interact with the game server.

Example Code Snippet

using Oxide.Core;

public class MyMod : RustPlugin {
    void Loaded() {
        Puts("My mod has loaded!");
    }
}

Community Support

Join the uMod community for discussions, help, and sharing your mods.