Skip to content
These docs reflect Contracts v0.6.0, the latest release. Older servers may differ.

Permissions

Controls who can use Contracts, who counts as an admin, and how many contracts each group of players may run and pin to their HUD.

{
"Permissions": {
"Use Contracts Features": "contracts.use",
"Admin": "contracts.admin",
"Max Active Contracts": {
"contracts.use": 3,
"contracts.vip": 5,
"contracts.admin": -1
},
"Max Tracked Contracts (HUD)": {
"contracts.use": 2,
"contracts.vip": 5,
"contracts.admin": -1
}
}
}
SettingTypeDefaultDescription
Use Contracts Featuresstringcontracts.useThe permission a player needs to open and use Contracts.
Adminstringcontracts.adminThe permission that unlocks admin actions.
Max Active Contractspermission mapcontracts.use: 3, contracts.vip: 5, contracts.admin: -1How many contracts a player may have active at once, keyed by permission. -1 means unlimited. Highest limit applies. This can also be configured per category.
Max Tracked Contracts (HUD)permission mapcontracts.use: 2, contracts.vip: 5, contracts.admin: -1How many contracts a player may pin to the on-screen HUD at once, keyed by permission. -1 means unlimited. Highest limit applies.

Max Active Contracts and Max Tracked Contracts (HUD) are maps from a permission to a number. You grant the permissions to players (or groups) with your framework’s permission system, then set a limit per permission here.

When a player holds more than one of the listed permissions, the limit resolves like this:

  • The player gets the highest limit among the permissions they hold. A VIP who also has contracts.use gets 5, not 3.
  • If any held permission is set to -1, the player is unlimited, regardless of the other numbers.
  • A value below -1 is treated as -1 (unlimited).
  • A player holding none of the listed permissions has no limit applied. For that reason, it’s important to include the Use Contracts Features permission in the map.
  • Contracts registers permissions listed in the config file at startup.