Installation
Don’t have Contracts yet? Get the plugin!
Contracts is a Rust server plugin. It runs on both Oxide and Carbon. The same Contracts.cs file works on
either framework.
1. Download the plugin
Section titled “1. Download the plugin”You can download the plugin here.
The download is a .zip file containing the plugin and default data files. Extract the folder to your computer and you’ll find the following files. The folder structure matches your server’s oxide or carbon folder, so you can copy the files directly into your server’s root folder.
Directoryplugins
- Contracts.cs The plugin file.
Directorydata
DirectoryContracts
- contracts_data.json Contains your contracts
- contract_category_data.json Contains hourly/daily/weekly/wipe categories with assigned contracts
- preset_data.json Contains presets used by the contracts
- custom_reward_data.json Contains custom reward definitions (empty by default)
- prestige_data.json Contains the prestige track (empty by default)
2. Install ImageLibrary (Oxide only)
Section titled “2. Install ImageLibrary (Oxide only)”On Oxide, install ImageLibrary before the first load. Contracts uses it for the icons and images in the in-game menu. Carbon has this built in, so skip this step on Carbon.
Every other plugin is optional and listed on the Integrations page. Install one only when a contract uses one of its types.
3. Install the plugin
Section titled “3. Install the plugin”Copy plugins/Contracts.cs into your server’s plugins directory:
oxide/plugins/carbon/plugins/Optionally, you can also copy the data/Contracts folder into your server’s data directory. If you don’t, the plugin will create these same files on first load. You may also pre-configure your data in the Web editor and copy the files into your server’s data folder, so your server starts with your pre-configured contracts.
oxide/data/carbon/data/Unless you’ve configured your server’s framework differently, the plugin compiles and loads automatically. Otherwise you can load it manually:
o.reload Contractsc.reload ContractsOn first load it writes its configuration, language and loads the default data.
4. Grant the permission
Section titled “4. Grant the permission”Players need the contracts.use permission to open the menu (and progress through contracts). Grant it to a group (for example the default default group, so everyone gets it):
o.grant group default contracts.usec.grant group default contracts.useServer admins should also hold contracts.admin for the management console commands.
| Permission | Grants |
|---|---|
contracts.use |
Open the menu and complete contracts |
contracts.admin |
Run admin console commands (rotate, reset progress) |
The exact permission strings are configurable in the plugin config under Permissions. The permissions shown above are the defaults.
5. Open the menu
Section titled “5. Open the menu”You’re all set! Players can now open the menu with the default chat command: /contracts. Type this in chat and you should see the menu appear. Players can also click the CONTRACTS button
next to MISSIONS on their inventory screen (see Menu Shortcut).
You can also configure a custom chat command in the plugin’s config.
