Loyalty Rewards 0.5.1

Loyalty Rewards is a plugin for Rust that automatically promotes and demotes players based on their activity on the server. Players can earn promotions to new permission groups after a certain number of active days, while inactivity may result in demotion. The plugin works seamlessly with the server's wipe cycle or customizable periods, making it an essential tool for rewarding loyal players.

Features

• Automated promotions and demotions based on player activity.
• Supports Rust wipe cycle or configurable periods.
• Multiple promotion levels (e.g., endurer, veteran, legend).
• Permission group management without affecting non-managed groups.
• Customizable promotion thresholds and inactivity demotion thresholds.
• Player notifications for both online and offline promotions.
• Manual promotion/demotion commands with added admin control.
• Data cleanup for inactive players not in any promotion group.
• Keeppromotioneligibility: Allows promoting players without making them ineligible for future promotions in the current period.

Configuration Variables Explanation

• UseWipeCycle: Toggle between using the Rust wipe cycle or a custom period (true/false).
• Period: Length of the period in days before resetting active days and promotion flags.
• RequiredDays: Number of active days required for promotion within the period.
• DemotionThreshold: Fraction of active days required to avoid demotion.
• MinimumPeriod: Number of days before demotions are possible.
• PromoteImmediately: Set to true if you want promotions to occur as soon as players meet the required days.
• PermissionRequired: Set to true if players must belong to a specific permission group to be eligible for promotions.
• RequiredPermissionGroup: Name of the group required for promotion eligibility.
• PromotionGroups: List of groups a player can be promoted to (e.g., endurer, veteran, legend).

Configuration Example

{
  "UseWipeCycle": true,
  "Period": 30,
  "RequiredDays": 7,
  "DemotionThreshold": 0.5,
  "MinimumPeriod": 2,
  "PromoteImmediately": false,
  "PermissionRequired": false,
  "RequiredPermissionGroup": "linked",
  "PromotionGroups": [
    "endurer",
    "veteran",
    "legend"
  ]
}

Permissions

• loyaltyrewards.admin: Allows use of admin commands to manually promote, demote, and reset the period for players.

Admin Commands

• /lr.promote <player> [levels] [keeppromotioneligibility]: Manually promote a player by specified levels. Use keeppromotioneligibility to allow further promotions in the current period.
• /lr.demote <player>: Manually demote a player to the previous group.
• /lr.resetperiod <withpromotions|withoutpromotions>: Resets the current period. Use withpromotions to process promotions/demotions or withoutpromotions to reset without processing.
• /lr.cleanup ihaveabackup: Cleans up inactive players not in any promotion groups.

Player Commands

• /lr.playtime: Allows players to check how many active days they have and whether they are eligible for promotion or at risk of demotion.

Operation Overview

• Players gain an "active day" for each calendar day they connect to the server.
• After a certain number of active days (set in the configuration), they are promoted to the next permission group.
• If players meet the promotion criteria during the period, they are promoted to the next group, and their old group is removed.
• Inactivity during the period below the demotion threshold results in players being demoted.
• The plugin handles promotions immediately if configured or during wipes, ensuring that players are rewarded based on their activity.
• Admins can manually promote, demote, or reset periods for all players.