Referrals

# Referrals A very customisable referral system, with support for milestones, rewards, waiting to execute rewards until player joins back, custom messages, reminders on join, account join time limits, referral limits, circular referral blocking, and placeholders. ## Config All config options are explained in the config.yml file <details> <summary>config.yml</summary> ```yaml # _____ __ _ _ _ #| __ \ / _| | | | | (_) #| |__) | ___ | |_ ___ _ __ _ __ __ _ | | _ __ | | _ _ __ _ _ _ __ #| _ / / _ \ | _| / _ \ | '__| | '__| / _` | | | | '_ \ | | | | | | / _` | | | | '_ \ #| | \ \ | __/ | | | __/ | | | | | (_| | | | | |_) | | | | |_| | | (_| | | | | | | | #|_| \_\ \___| |_| \___| |_| |_| \__,_| |_| | .__/ |_| \__,_| \__, | |_| |_| |_| # | | __/ | # |_| |___/ # Prefix # The prefix to use in messages # default: "&6&l" prefix: "&6&l" # Circlular referrals # If player1 refers player2, can player 2 also refer player1? # default: false circular-referrals: false # Maximum referrals # How many players can one player refer? # Set to -1 for unlimited referrals # default: -1 max-referrals: -1 # Maximum age # How many seconds can a user have played before they cannot run /refer to claim their referral? # Set to -1 for no limit # default: 86400 (24 hours) max-age: 86400 # Referree joined requirement # Does the player that referred the player have to have joined the server before the referree joins? # This helps prevent players from putting invalid usernames. # default: true referree-joined-requirement: true # Notify on join # Should players that haven't been referred be notified about the referral system on join, if the max-age hasn't been exceeded? # default: true notify-on-join: true # Notify delay # How long to wait (in milliseconds) before sending the notify message on join # This ensures the message appears after the join message # default: 1000 (1 second) notify-delay: 1000 # Messages # Customize all messages sent by the plugin # Available placeholders: # {prefix} - The prefix defined above # {player} - The player's username # {referrer} - The referrer's username # {claimer} - The claimer's username # {max-age} - The max age in seconds # {max-age-hours} - The max age in hours # {max-referrals} - The max referrals limit # {hours} - Hours remaining (for time-remaining message) # {minutes} - Minutes remaining (for time-remaining message) # {value} - Generic value placeholder messages: # Command messages player-only: "&cThis command can only be used by players." no-permission: "&cYou do not have permission to use this command." # /refer command messages refer-usage: "&cUsage: /refer <username>" refer-success: "{prefix} &aYou have been referred by {referrer}!" already-referred: "{prefix} &cYou have already set your referrer!" cannot-refer-self: "{prefix} &cYou cannot refer yourself!" referrer-not-joined: "{prefix} &cThe player '{referrer}' has not joined the server before!" account-too-old: "{prefix} &cYou cannot set a referrer because your account is too old!" account-too-old-details: "&cMaximum age: {max-age} seconds ({max-age-hours} hours)" circular-referral-blocked: "{prefix} &cCircular referrals are not allowed! {referrer} was referred by you." max-referrals-reached: "{prefix} &cThe player '{referrer}' has reached the maximum number of referrals!" # /refer explanation (when no args provided) refer-explanation-header: "{prefix} &eReferral System" refer-explanation-line1: "&eIf someone referred you to this server, use this command to give them credit!" refer-explanation-usage: "&eUsage: &a/refer <username>" refer-explanation-current: "&aYou were referred by: &f{referrer}" refer-explanation-time-remaining: "&eYou have &a{hours} hours and {minutes} minutes &eto claim your referral." refer-explanation-expired: "&cYour account is too old to claim a referral." refer-explanation-no-limit: "&eYou can claim your referral at any time!" # Join notification messages notify-line1: "{prefix} &eYou haven't set who referred you yet!" notify-line2: "&eUse &a/refer <username> &eto claim your referral reward!" # /referral help command help-header: "{prefix} &eReferral Plugin Commands:" help-refer: "&a/refer <username> &7- Claim who referred you to the server" help-referral-help: "&a/referral help &7- Show this help message" help-referral-config: "&a/referral config &7- View current configuration" help-referral-reload: "&a/referral reload &7- Reload the plugin configuration" # /referral command messages referral-usage: "&cUsage: /referral <help|config|reload>" referral-unknown-subcommand: "