Modules

Referrals

New players naming who invited them: the join window, the checks, settling in, referrals.yml, milestones and resetting a referral.

A new player types /referral <player> to name who invited them. Nothing is paid yet: both players are rewarded once the new player has played referrals.qualify-minutes (default 60) since naming somebody, idle time not counted, as ExyliaLib's playtime tracker counts it on every server of the network.

Naming who invited you

/referral <player> (also /ref and /referrals) needs exyliarewards.referrals.use. It is refused when:

Refusal	Why
Too late	More than `referrals.join-window-hours` (default 72) have passed since the player's first join anywhere on the network.
Yourself	A player cannot name themselves.
Same connection	With `referrals.block-same-address` on (the default), the two accounts used the same address within the last 30 days, on any server, or are online from it now. When the records cannot answer, the referral is refused.
Already named	A player names one referrer, once.
Circular	The player being named already named this player: two players cannot invite each other.

When it is accepted, the referrer is told wherever they are on the network, or on their next join.

Settling in

Once the new player has played long enough, both are paid at the same moment, and the referrer's count of players brought goes up. If the count reaches a milestone, the referrer is paid that too. Only one server can settle a referral, so a player moving servers at that minute pays nobody twice. Either player may be offline or on another server: what they earn is delivered by id, and the line saying why reaches them where they are, or on their next join.

referrals.yml

invited:
  rewards:
    - type: ECONOMY
      value: '50'
  message: '%prefix% {success}You settled in! {highlight}%friend% {letters}invited you ...'
 
referrer:
  rewards:
    - type: ECONOMY
      value: '150'
  message: '%prefix% {highlight}%friend% {letters}is settling in, thanks to you ...'
 
milestones:
  '5':
    rewards:
      - type: ECONOMY
        value: '750'
    message: '%prefix% {highlight}5 {letters}friends brought to the server ...'

Section	Paid
`invited`	To the new player, once they have played long enough.
`referrer`	To whoever invited them, at the same moment.
`milestones`	Once to a referrer when exactly that many of the players they invited have settled in. The bundled file has 5 and 15.

Every block takes rewards, an ExyliaLib reward list (see Rewards in ExyliaLib), and message (empty for none). In messages: %player% (who is paid), %friend% (the other player), %count% (players the referrer brought), %rewards% and %money%. Money and items are boosted for the referrals source. Like votes.yml, the file is yours and reloads with /rewardsadmin reload.

Seeing your referrals

/referral with no name shows who invited you, how many players you brought, how many are still settling in, the next milestone, and how new players name you. The Referrals card of /rewards shows the same.

Resetting a referral

/referraladmin reset <player> (also /refadmin reset, exyliarewards.referrals.admin) forgets who a player named, so they can name somebody again. It asks for confirm first: /referraladmin reset <player> confirm. Only a referral nobody was paid for yet can be reset; one that already settled in stays.

Something missing on this page? Tell us on Discord