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.

Quickstart

Already comfortable with Oxide/Carbon? Copy Contracts.cs into oxide/plugins/ (or carbon/plugins/), install ImageLibrary, then run o.grant group default contracts.use and open the menu with /contracts. The sections below walk through the same steps in detail.

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

Tip

While you’ll typically only need to copy the data/Contracts files once on your initial setup, these data files can be useful for you in future updates too! If new default contracts are added in a future version, you can:

1. Load your current data files into the Web editor
2. Drop the bundled data files into the editor
3. A modal will appear and let you selectively merge new contracts/categories/presets into your existing data files, without overwriting your existing data!

Learn more about what is included.

2. Install dependencies

Contracts has a few required and optional dependencies. Required dependencies must be installed for the plugin to work. Optional dependencies are only needed if you want to use certain features.

Plugin	Needed for	Required?
ImageLibrary	Icons and images in the in-game menu. Install this before the first load.	Yes
Economics	Economics rewards	Only if you grant Economics rewards
ServerRewards	ServerRewards rewards	Only if you grant RP
Monument Finder	Monument Objective Condition	Only if you want to use the Monument Condition (which some default contracts use)

Note

You can have Economics and ServerRewards rewards configured in your contracts without having the plugin installed. At the time of reward distribution, these rewards will be skipped. This makes it easier to use shared contracts!

3. Install the plugin

Copy plugins/Contracts.cs into your server’s plugins directory:

Oxide

oxide/plugins/

Carbon

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

oxide/data/

Carbon

carbon/data/

Unless you’ve configured your server’s framework differently, the plugin compiles and loads automatically. Otherwise you can load it manually:

Oxide

o.reload Contracts

Carbon

c.reload Contracts

On first load it writes its configuration, language and loads the default data.

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):

Oxide

o.grant group default contracts.use

Carbon

c.grant group default contracts.use

Server 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

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.

You can also configure a custom chat command in the plugin’s config.

Inform your players

Make sure to inform your players about the plugin’s commands somewhere (such as your welcome panel) so they know how to use Contracts!