Reference¶

Commands, permission nodes and config keys, read straight from the source code. For how and why to use them, see the other pages.


Plugin	`ReferralRewards`
Version	1.0.0
Install	Paper/Bukkit plugin (backends)
Git	https://github.com/Pixelrus/referral-rewards
Depends on	`AzLink (soft)`

Commands¶

Command	Who can use it	Description
`/referral`	no check declared	View or redeem referral codes Usage: `/referral [friend-code]` Aliases: `/refer`

Permission nodes¶

Node	Default	What it allows
`referralrewards.admin`	op	Full access to ReferralRewards administration commands

Config¶

File	Key	Default
`plugins/ReferralRewards/config.yml`	`server-name`	`main`
`plugins/ReferralRewards/config.yml`	`database.url`	`jdbc:mariadb://127.0.0.1:3306/referral_rewards`
`plugins/ReferralRewards/config.yml`	`database.username`	`referral_rewards`
`plugins/ReferralRewards/config.yml`	`database.password`	`change-me`
`plugins/ReferralRewards/config.yml`	`database.maximum-pool-size`	`4`
`plugins/ReferralRewards/config.yml`	`database.connection-timeout-ms`	`10000`
`plugins/ReferralRewards/config.yml`	`referrals.code-length`	`7`
`plugins/ReferralRewards/config.yml`	`referrals.eligible-days-after-first-join`	`30`
`plugins/ReferralRewards/config.yml`	`referrals.referrer-reward-amount`	`5.00`
`plugins/ReferralRewards/config.yml`	`referrals.referred-reward-amount`	`5.00`
`plugins/ReferralRewards/config.yml`	`azuriom.enabled`	`true`
`plugins/ReferralRewards/config.yml`	`azuriom.base-url`	`https://your-azuriom-site.example.com`
`plugins/ReferralRewards/config.yml`	`azuriom.server-token`	`change-me`
`plugins/ReferralRewards/config.yml`	`azuriom.server-id`	`1`
`plugins/ReferralRewards/config.yml`	`azuriom.create-missing-users`	`true`
`plugins/ReferralRewards/config.yml`	`azuriom.uuid-format`	`undashed`
`plugins/ReferralRewards/config.yml`	`azuriom.connect-timeout-ms`	`10000`
`plugins/ReferralRewards/config.yml`	`azuriom.request-timeout-ms`	`15000`
`plugins/ReferralRewards/config.yml`	`messages.prefix`	`'&bReferrals &8> '`
`plugins/ReferralRewards/config.yml`	`messages.code`	`'&fYour referral code is &a{code}&f. &7Click the code to cop`
`plugins/ReferralRewards/config.yml`	`messages.usage`	`'&eUse &f/referral &eto see your code or &f/referral <friend`
`plugins/ReferralRewards/config.yml`	`messages.redeem-success`	`'&aReferral accepted. &f{referrer}&a received &f${referrer_a`
`plugins/ReferralRewards/config.yml`	`messages.already-referred`	`'&cYou have already used a referral code.'`
`plugins/ReferralRewards/config.yml`	`messages.self-referral`	`'&cYou cannot use your own referral code.'`
`plugins/ReferralRewards/config.yml`	`messages.code-not-found`	`'&cThat referral code was not found.'`
`plugins/ReferralRewards/config.yml`	`messages.not-eligible`	`'&cYou can only use a referral code within {days} days of yo`
`plugins/ReferralRewards/config.yml`	`messages.credit-failed`	`'&cReferral was not recorded because the Azuriom credit coul`
`plugins/ReferralRewards/config.yml`	`messages.pending`	`'&7Checking referral data...'`
`plugins/ReferralRewards/config.yml`	`messages.admin-reloaded`	`'&aReferralRewards reloaded.'`