Reminders

Reminders nudge players about things they can act on right now. There are two:

Available Contracts: the player has a free contract slot and at least one contract they could accept right now.
Unclaimed Rewards: the player holds an unclaimed contract reward or an unclaimed objective reward.

A reminder only sends when its condition is true at that moment, and only to players with permission to use the plugin.

{
  "Reminders": {
    "Available Contracts": {
      "Enabled": true,
      "Trigger": "Awake",
      "Interval": null,
      "Amount": 5,
      "Cooldown": 300,
      "Method": "Chat"
    },
    "Unclaimed Rewards": {
      "Enabled": true,
      "Trigger": "Awake",
      "Interval": null,
      "Amount": 5,
      "Cooldown": 300,
      "Method": "Chat"
    }
  }
}

Fields

Both reminders take the same fields:

Field	Type	Default	Description
`Enabled`	boolean	`true`	Send this reminder.
`Trigger`	enum: Time \| Awake \| MenuClose	`"Awake"`	When the reminder fires. Time fires every Interval seconds. Awake fires when a player wakes up. MenuClose fires when a player closes the contracts menu.
`Interval`	integer \| null	`null`	Seconds between reminders when Trigger is Time. Must be above 0 for the Time trigger, the plugin resets it to 3600 at load otherwise. Other triggers ignore it, leave it null then.
`Amount`	integer (min -1)	`5`	How many times the reminder can fire before it goes quiet. The count resets when the player acts on it, like opening the menu or claiming a reward. -1 means no limit.
`Cooldown`	integer (min 0)	`300`	Seconds before the same reminder can fire again for a player. Only applies to the Awake and MenuClose triggers, Time paces itself with Interval.
`Method`	enum: Chat \| Toast	`"Chat"`	How the reminder shows up: a chat message or a toast popup in the bottom left.

Triggers

Time sends the reminder every Interval seconds to connected, awake players. If you pick Time without a positive Interval, the plugin warns on load and uses 3600 (one hour).
Awake sends it when the player wakes from sleep: after connecting, after death, after teleporting.
MenuClose sends it when the player closes the Contracts menu.

Whatever the trigger, the reminder only sends if its condition is true at that moment, its cooldown has passed, and its Amount is not used up. Triggers on cooldown don’t count toward Amount.

When the plugin stops reminding

Amount caps how much a player gets nagged. Every sent reminder of a type counts toward it, and when the cap is reached that reminder goes quiet for that player. Acting on the reminder resets the count to zero:

Accepting a contract resets Available Contracts reminders.
Claiming a reward resets Unclaimed Rewards reminders.

Acting also starts the cooldown, so a player who just accepted or claimed gets quiet time instead of an instant follow-up.

Counts and cooldowns live in memory only. A player who disconnects starts fresh, and a server restart or plugin reload resets everyone.

Players can turn reminders off

A player can silence all reminders for themselves with /contracts reminders or with the toggle in the preferences menu. That is their preference and it applies to them only. If reminders are turned off (Enabled is false) in the config, the plugin never sends them to anyone, regardless of their personal preference. So it’s recommended to leave reminders on and let players turn them off if they want.

Privacy