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
- Download the latest release from the uMod website.
- Unzip the files into your game’s server directory.
- Start your server, and uMod will load automatically.
Usage
Once installed, you can create and install plugins:
Creating a Plugin
To create a plugin:
- Use the provided template in the
Pluginsfolder. - Follow the programming guidelines in the documentation.
Installing Plugins
- Place the plugin files in the
Pluginsdirectory 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.