RewardsPlusPlus - Rewards.yml

Aug 31, 2016
RewardsPlusPlus - Rewards.yml
  • THE OFFICIAL REWARDS++ WIKI
    (REWARDS.YML)

    Hello and welcome to the Official Rewards++ Wiki,
    Here you can learn how to create rewards and about the plugin placeholders and such.

    If you're here is because you want to create a reward and want to know how and what you put and how far can you go with rewards.

    The plugin will generate a rewards.yml in the storage folder by default there is 3 rewards. Like this
    [​IMG]
    Code (Text):
    Rewards:[/I][/I][/SIZE][/FONT][/LEFT]
    [FONT=Courier New][SIZE=4][I][I]Rewards:
      Vote:
        displayName: "&eVote reward"
        slot: 0
        type: VOTE-1
        cooldown: 10
        permission: false
        availableMaterial: EMERALD_BLOCK-0-1
        needPermissionMaterial: REDSTONE_BLOCK-0-1
        cooldownMaterial: COAL_BLOCK-0-1
        needValueMaterial: REDSTONE_BLOCK-0-1
        availableLore:
        - "&u%player_name%&a, this reward"
        - "&ais available to be collected!"
        needPermissionlore:
        - "&u%player_name%&c, You need the permission"
        - "&crewards.Daily"
        cooldownLore:
        - "&u%player_name%&3, this reward"
        - "&3is not available, please wait..."
        - "&3%rewards_cooldown_time%"
        needValueLore:
        - "&u%player_name%&e, you don't"
        - "&ehave enough for this reward."
        - "&eCurrent votes: &6%rewards_player_votes%"
        onSuccessClickCommands:
        - "give %player_name% diamond 5"
        - "eco give %player_name% 500"
        - "pmessage &b&l[!] &3&oYou have collected your vote reward!"
        - "playsound ENTITY_PLAYER_LEVELUP:1:1"
        onNeedPermissionClickCommands:
        - "pmessage %player_name% &c&l[&4&l!&c&l]&r &4You need the permission &crewards.Vote &4to claim this reward."
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onCooldownClickCommands:
        - "pmessage &e&l[&6&l!&e&l]&r &6This reward is currently on cooldown!"
        - "pmessage &r    &eUnlock in:&r %rewards_cooldown_time%"
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onNeedValueClickCommands:
        - "pmessage &e&lYou don't have enough votes!"
        - "pmessage &eCurrent votes: &6%rewards_player_votes%"
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        servers: []
      Daily:
        displayName: "&bDaily reward"
        slot: 4
        type: NONE-0
        cooldown: 86400
        permission: true
        availableMaterial: EMERALD_BLOCK-0-1
        needPermissionMaterial: REDSTONE_BLOCK-0-1
        cooldownMaterial: COAL_BLOCK-0-1
        needValueMaterial: REDSTONE_BLOCK-0-1
        availableLore:
        - "&u%player_name%&a, this reward"
        - "&ais available to be collected!"
        needPermissionlore:
        - "&u%player_name%&c, You need the permission"
        - "&crewards.Daily"
        cooldownLore:
        - "&u%player_name%&3, this reward"
        - "&3is not available, please wait..."
        - "&3%rewards_cooldown_time%"
        needValueLore: []
        onSuccessClickCommands:
        - "give %player_name% diamond 5"
        - "eco give %player_name% 500"
        - "pmessage &b&l[!] &3&oYou have collected your daily reward!"
        - "pmessage &r    &e&oCome back tomorrow for more!"
        - "playsound ENTITY_PLAYER_LEVELUP:1:1"
        onNeedPermissionClickCommands:
        - "pmessage %player_name% &c&l[&4&l!&c&l]&r &4You need the permission &crewards.Daily &4to claim this reward."
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onCooldownClickCommands:
        - "pmessage &e&l[&6&l!&e&l]&r &6This reward is currently on cooldown!"
        - "pmessage &r    &eUnlock in:&r %rewards_cooldown_time%"
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onNeedValueClickCommands: []
        servers: []
      Economy:
        displayName: "&bEconomy reward"
        slot: 8
        type: ECONOMY-500
        cooldown: 10
        permission: false
        availableMaterial: EMERALD_BLOCK-0-1
        needPermissionMaterial: REDSTONE_BLOCK-0-1
        cooldownMaterial: COAL_BLOCK-0-1
        needValueMaterial: REDSTONE_BLOCK-0-1
        availableLore:
        - "&u%player_name%&a, this reward"
        - "&ais available to be collected!"
        needPermissionlore:
        - "&u%player_name%&c, You need the permission"
        - "&crewards.Daily"
        cooldownLore:
        - "&u%player_name%&3, this reward"
        - "&3is not available, please wait..."
        - "&3%rewards_cooldown_time%"
        needValueLore:
        - "&u%player_name%&e, you don't"
        - "&ehave enough for this reward."
        onSuccessClickCommands:
        - "give %player_name% diamond 5"
        - "@all eco give %player_name% 100" #In this case i gave all online players $100 don't give money like this they can abuse...
        - "pmessage &b&l[!] &3&oYou have collected your economy reward!"
        - "playsound ENTITY_PLAYER_LEVELUP:1:1"
        onNeedPermissionClickCommands:
        - "pmessage %player_name% &c&l[&4&l!&c&l]&r &4You need the permission &crewards.Economy &4to claim this reward."
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onCooldownClickCommands:
        - "pmessage &e&l[&6&l!&e&l]&r &6This reward is currently on cooldown!"
        - "pmessage &r    &eUnlock in:&r %rewards_cooldown_time%"
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        onNeedValueClickCommands:
        - "pmessage You don't have enough money!"
        - "playsound BLOCK_ANVIL_DESTROY:1:1"
        servers: []
        #==============Information========================
        # Wiki: https://www.spigotmc.org/wiki/rewardsplusplus/
        # Placeholders: https://www.spigotmc.org/wiki/rewardsplusplus-placeholders/
        # Rewards config: https://www.spigotmc.org/wiki/rewardsplusplus-rewards/?noRedirect=1
        # Permissions & Commands: https://www.spigotmc.org/wiki/rewardsplusplus-permissions-commands/
        #
        # How to create a reward tutorial:
        # Name the reward (name must not be the same as another reward.)
        # display name: <how you want it to apper in the on screen GUI
        # slot:  This is the CHEST Slot in the GUI numbers 0-54
        #            NOTE: if your using a bungee server, you can use the same slot of two diffrent
        #                         rewards. You just need to add the server's name as it appears
        #                         in the server.properties to the 'server' section.
        # type: Available rewards are: 'none' meaning, you don't need votes or income to unlock
        #                                                      'vote' votes are requied to unlock these rewards.
        #                                                      ' economy' money is required to unlock these rewards.
        #
        # you can decide if the player needs a permission or not as well. for any of the types.
        # For 'economy' rewards, if you set the price by doing : -<amount> example: "economy-50"
        # The same goes for the 'vote' reward, put a - and then the amount of votes needed after the -
        # By default, you should set the NONE reward to -0
        # cooldown: This is the amount of time in seconds before the reward is made available again
        # to the player.
        # availableMaterial: EMERALD_BLOCK-0-1
        # needPermissionMaterial: REDSTONE_BLOCK-0-1
        # cooldownMaterial: COAL_BLOCK-0-1
        # needValueMaterial: REDSTONE_BLOCK-0-1
        #
        # this is used as the visual material seen in the GUI. You can change it to any block you want.
        # Set like this: <material> - <durability> - <amount> The durability is for the type of block.
        # such as the color of the wool. For the amount, just put 1
        # availableLore:
        #   - "&2%player_name%&a, this reward"
        #   - "&ais available to be collected!"
        #
        # This is what is displayed in the info panel when a player hovers over the reward.
        # It can say whatever you want. New lines are started with the -
        # You can add up to infinite lines of lore.
        #                Its possible to add unlimited i guess but players will be annoyed by it...
        #
        # needPermissionlore:
        #   - "&4%player_name%&c, You need the permission"
        #   - "&crewards.Daily"
        #
        # This is what shows up if the player does not have the correct
        # permissions to unlock that reward. Give the player the correct
        # permission by giving them: 'rewards.<name of reward>'
        #
        # cooldownLore:
        #   - "&b%player_name%&3, this reward"
        #   - "&3is not available, please wait..."
        #   - "&3%rewards_cooldown_time%"
        #
        # This is what is shown if the player as already unlocked the
        #  reward and must wait for it to cooldown.
        #
        # needValueLore:
        #   - "&6%player_name%&e, you don't"
        #   - "&ehave enough for this reward."
        #   - "&eCurrent votes: &6%rewards_player_votes%"
        #
        # this is what is displayed if you have a price or vote amount on the reward.
        # you can have this say whatever you want.
        #
        # onSuccessClickCommands:
        # - after the - you can add whatever commands you want to run for the player.
        # - They must be un qutations to work.
        #
        # Examples:
        # - "give %player_name% diamond 5"
        # - "eco give %player_name% 500"
        #
        # NOTES: You can add @all before a command to have it run for everyone on the server if it
        #               is unlocked by another player.
        #  Example:
        # - " @all give %player_name% diamond 1"
        #  Running this command will give everyone who is on the server at the time 1 Diamond.
        # (this can help keep your vote reward setup EULA compliant. :)
        #
        #  onNeedPermissionClickCommands:
        # - "pmessage %player_name% &c&l[&4&l!&c&l]&r &4You need the
        #    permission &c%rewards_permission_needed% &4to claim this
        #    reward."
        # This is the message that is sent to the user thru chat if they
        # don't have the proper permission. You can edit it to say
        # whatever you want.
        #
        # onCooldownClickCommands:
        #   - "pmessage &e&l[&6&l!&e&l]&r &6This reward is currently on
        #      cooldown!"
        #
        # This is the message that is sent to the player if they click on
        # a reward while it is still in cooldown mode.
        # you can edit it to say whatever you want.
        #
        # onNeedValueClickCommands:
        #    - "pmessage &e&lYou don't have enough votes!"
        #    - "&eCurrent votes: &6%rewards_player_votes%"
        #
        # This is the message that is displayed in chat if the player
        # still needs more vote points, or money to unlock the reward.
        # You can edit it to say whatever you want.
        #  Leave the servers empty like so if you don't use bungee or MySQL
        # servers: []
        #
        # Leave blank if you don't use bungee.
        # You can have a reward run only on certain servers within your
        # bungee network by adding the server name here. (MySQL Required)
        #
        # Available placeholders:
        # https://www.spigotmc.org/wiki/rewardsplusplus-placeholders/
        #
        # "@all" add this BEFORE a command to have it run for everyone
        # who is on the server at the time.
        # -------------------------NOTES-----------------------------
        # You can add in minecraft color codes by putting a & before
        # Example: & &a will give the color lime.
        #
        #
    [LEFT]






    Now there is a lot you can do in there there is no limits.
    Lets start with Vote rewards, and how they work.
    Rewards++ vote system is quit unique i wont say no other plugin has it but no other voting plugin has it integrated with a gui and rewards system. Which gives this plugin a quit unique aspect. Rewards++ uses a custom currency called "Vote Currency" thats just a name for it you won't see any commands in game such as /votes or anything its just a stored value you need to get the Vote reward. Now whats more unique about this system is that you can specify how many votes a player needs to make to actually get a reward, it can be 10, 100, 1000 and so on! now each reward has its placeholders. its a whole different section.

    Now for the ECONOMY Reward i don't have to explain anything here is quit self explanatory just like a shop you have the money you get the reward, simple.

    Now the NONE reward its just a reward that requires nothing but time and if you put permission yes it requires the permission and the cooldown time and thats it.

    Now how do you set what each reward will do when a player clicks it?
    head to this section of the rewards.
    [​IMG]
    List of available custom commands: (Note it supports all type of commands this is just custom commands lines to do specific things such as sounds and fireworks.)
    - pmessage <message>
    (sends specific message to play supports color and placeholders).
    - playsound <sound_name>:<volume>:<pitch> (plays specific sound to the player)
    - playfirework (Plays a random generated firework at the players location).

    Now the picture explains it self but i will explain it here as well, there is global commands and only for the player commands to make a global command you would place a @all before it. for example: '@all eco give %player_name% 100'
    That will give all online players including the player who activated the reward 100 in game currency. now if you want to send a message to the player you place a pmessage and the message after it.
    for example: 'pmessage this is a message for the player.'
    See how easy it is ? ok now @all doesn't work on all the commands values it only works on the onSuccessClickCommands. But why ? wouldn't it be silly if a player clicks on a reward and its on cooldown or need permission so you send a message to all players saying they dont have permission... ? yea it would. xD
    ok so that's all for the commands section now moving to the last section called servers:
    [​IMG]
    Its empty by default, but if you put for example kitpvp or creative that reward will only show on that server of course you would need MySQL for it to work properly it would be silly not having MySQL and putting servers in there so idk about you but if i'm having a single server i will keep that empty.

    That's it. thanks for viewing RewardsPlusPlus Wiki!
    For a full list of placeholders head to RewardsPlusPlus placeholders page!
  • Loading...
  • Loading...