UltimateRewards Wiki
  • Getting started
    • Support
  • Addons
  • Configs
    • Player Levels
    • Referrals
    • Loginstreak
  • USAGE
    • Installation
    • Commands
  • configuration
    • Rewards
      • Creating Reward
      • Reward Types
        • Afk Reward
          • World Afk Reward
          • Area Afk Reward
          • Region Afk Reward
        • Advent Calendar
        • Pickable Reward
        • Time Reward
        • Time Fixed Reward
        • Streak Reward
        • Streak Fixed Reward
        • Vote Reward
        • Renewable Vote Reward
        • Per Vote Reward
        • Streak Vote Reward
        • Play Time Reward
        • Renewable Play Time Reward
        • Referral Reward
        • Renewable Referral Reward
        • Purchasable Reward
        • Re-Purchasable Reward
        • One Time Reward
        • Time Limited Reward
        • Custom Reward
        • Multiple Custom Reward
        • Coupon Reward
        • Discord Reward
      • Reward Settings
      • Reward Actions
      • Reward Features
        • Auto Claim
        • Notifications
        • Reward NPC
        • Discord Support
        • Reward Requirements
        • Reward Variants
        • Selectable Rewards
        • Randomization
          • Execution Chances
          • Random Placeholders
        • AFK Checkers
        • Leaderboards
    • Menus
      • Basics
      • Example of GUIs
      • Setting Menu
    • Schedules & Timers
  • Colors & Models
  • Placeholders
  • API
    • Events
    • Examples
    • Setting up own playtime calculator
  • Policies
    • TOS
Powered by GitBook
On this page
  • Managing commands
  • Menu commands
  • Main menu opening
  • Opening specific menu
  • Reward commands
  • Claiming reward commands
  • Show available rewards
  • Resetting reward commands
  • Testing reward actions commands
  • Reward settings commands
  • Referral commands
  • Creating referral command
  • Activating referral command
  • Resetting player being player referred to
  • Vote commands
  • Main command
  • Proceeding vote command
  • Resetting number of votes
  1. USAGE

Commands

Listed all valid syntaxes of commands and their permissions.

While the main command (which will be used in the following text) is/reward, you can also use the registered aliase/rw (also /rws for /rewards)

Permission to access for all commands:

ultimaterewards.admin

Some commands can also be executed from the console

Managing commands

To reload all .yml files of the plugin, use the following command:

Command
Permission

/reward reload

ultimaterewards.reload

If you changed the backed type to MySQL (or other DB types) you can use this command to import current data from the files:

/reward import

ultimaterewards.admin

Menu commands

The plugin offers the option to create a main GUI (the name of which will be main can be set in config.yml) and individual sub-menus that may or may not be interconnected. Command to open main GUI:

Main menu opening

/rewards

ultimaterewards.use

Opening specific menu

You can also directly specify which GUI menu to open.

All mentioned commands have full support for tab-completion of arguments

/reward open <menuName>

ultimaterewards.open

/reward open <menuName> (<player>)

ultimaterewards.open.others

Reward commands

Claiming reward commands

One of the basic reward commands will be for claiming a certain reward. The command may also include an argument for which player the reward should be claimed for.

The optional arguments are wrapped in round brackets

/reward claim <rewardName>

ultimaterewards.claim

/reward claim <rewardName> (<player>)

ultimaterewards.claim.others

Show available rewards

Displays all available rewards in the menu where they can be easily and clearly claimed.

/reward available

ultimaterewards.available

Resetting reward commands

The following command are used to reset the time cooldown of a reward.

/reward reset <player> <rewardName>

ultimaterewards.reset

Testing reward actions commands

The set reward can be tested by using the command.

/reward test <rewardName>

ultimaterewards.test

Reward settings commands

Specific settings can be toggled with the command:

/reward toggle <setting> (<player>)

ultimaterewards.<settingName>

Referral commands

You can also use /ref aliase

Creating referral command

To create a referral:

/referral create

ultimaterewards.referral.create

Activating referral command

After creating a custom referral, players can use the following command to activate their referral The referral code is always the name of the player who created it. It then adds 1 use to the player who owns the referral and rewards the player who activated the referral (rewards can be set in referrals.yml).

/referral apply <player>

ultimaterewards.referral.apply

Resetting player being player referred to

/referral reset <player>

ultimaterewards.admin

Vote commands

The /uvote command has also been registered, in case there is a conflict with a command from another plugin.

Main command

The main command is customizable, for example it can be used to display voting pages. Everything is of course configurable.

/vote

ultimaterewards.vote

Proceeding vote command

Vote can be proceeded manualy by:

/vote proceed <player>

ultimaterewards.admin

Resetting number of votes

/vote reset <player>

ultimaterewards.admin

Last updated 4 months ago