Integrations

Contracts works with a few other plugins. Each one unlocks some objective, condition, reward or cost types. Your server only needs a plugin when one of your contracts uses one of its types. The default contracts use types from Monument Finder, Economics and Server Rewards.

Every type that needs a plugin carries a Needs badge at the top of its page. For what happens when a contract uses a type whose plugin is not installed, see When a plugin is missing.

Monument Finder

Monument Finder is a free plugin. Types that need it:

• Objectives: Visit
• Conditions: Monument

Monument Finder is needed even when the monument list is empty (any monument), because Contracts reads every monument’s bounds from it.

Economics

Economics is a free plugin. Types that need it:

• Rewards: Economics
• Costs: Economics

The Economics reward pays money into the player’s Economics balance, and the Economics cost takes it out when they accept the contract.

Server Rewards

Server Rewards is a free plugin. Types that need it:

• Rewards: Server Rewards
• Costs: Server Rewards

The Server Rewards reward pays RP (reward points), and the Server Rewards cost takes RP from the player when they accept the contract.

Skill Tree

Skill Tree is a paid plugin. Types that need it:

• Rewards: Skill Tree XP, Skill Tree Points

Players also need Skill Tree’s skilltree.xp permission to gain XP. Without it, a Skill Tree XP reward shows as ineligible for them and is never paid.

Raidable Bases

Raidable Bases is a paid plugin. Types that need it:

• Objectives: Raidable Base
• Conditions: Raidable Base Zone

Both editions of Raidable Bases work. Raidable Bases Lite has a single difficulty, named Normal.

Contracts was last tested with Raidable Bases 3.2.2. When a newer version is running, the console warns once at load and Contracts keeps working. If Raidable Base objectives stop counting after a Raidable Bases update, check for a Contracts update or contact me on Discord to let me know.

Other plugins Contracts uses

• ImageLibrary (Oxide only): loads the icons and images of the in-game menu. On Carbon, Carbon’s own image database does this job instead. See Installation.
• PlayerDLCAPI: when it is installed and Use PlayerDLCAPI is on, Contracts checks that the player owns a skin or DLC before giving them a skinned item reward. See the Misc config.
• Leveling plugins (Skill Tree, XPerience, ZLevels Remastered and others): reward multiplier tiers can read a player’s level from any plugin you name. See Multipliers.

When a plugin is missing

• Objectives and conditions lock the contract. A contract that uses an objective or condition type whose plugin is not loaded is never drawn into a rotation, cannot be accepted and stays invisible to players. Its data is not touched. Load the plugin and the lock lifts right away, no restart needed. The contract can then be drawn from the next rotation, or put live now with contracts.add_to_rotation (see Admin commands).
• Unloading the plugin cancels the contracts that need it. Every active contract that uses one of its objective or condition types leaves the rotation and is cancelled for every player. That progress is dropped, whatever its state. Rewards already in the Contracts inventory stay there and can still be claimed, the same as with contracts.remove_from_rotation.
• That reward is skipped. A reward whose plugin is not loaded is never paid, not even from the Contracts inventory. The other rewards on the contract still pay, and the contract plays as usual. Players don’t see the skipped reward, except in the Contracts inventory, where it follows Rewards > Show Ineligible Rewards like any other ineligible reward. Claiming a bundle while the plugin is missing pays the rest of the bundle, and that reward is lost.
• Costs can’t be paid. A cost whose plugin is not loaded reads as a balance of 0, so players can’t afford the contract and can’t accept it.
• The console warns you. When Contracts loads and when one of these plugins unloads, the console prints a warning for each missing plugin, naming the contracts that need it. For rewards, it only names contracts that would give no rewards at all, so a contract that also pays items is left out.
• The editor shows it, but never blocks. The web editor marks every type that needs a plugin and exports your files either way.