diff --git a/src/main/resources/examples/reward_items.yml b/src/main/resources/examples/reward_items.yml index 1e4756c..6532319 100644 --- a/src/main/resources/examples/reward_items.yml +++ b/src/main/resources/examples/reward_items.yml @@ -25,7 +25,7 @@ # # {player} - The name of the player who voted # -# Be sure to enclose strings in quotes ('') if they contain special formatting codes such as & or hex colors. +# Be sure to enclose strings in quotes ("") if they contain special formatting codes such as & or hex colors. # # Examples: # @@ -74,7 +74,7 @@ # - A golden apple to keep you healthy. # reward_randomized: true # reward_max_items: 3 -# +# # ================================================================ diamond_pack: reward_name: Vote Reward diff --git a/src/main/resources/reward_items.yml b/src/main/resources/reward_items.yml index 8ac7630..0743849 100644 --- a/src/main/resources/reward_items.yml +++ b/src/main/resources/reward_items.yml @@ -13,11 +13,11 @@ # reward_id: (required, string with underscores, must be unique. Corresponds to reward_triggers.yml items) # reward_name: (required, string) # reward_items: (required, list of items to give) -# - item: (required, valid minecraft item name or Head Database ID starting with 'hdb-') -# title: (optional, string) -# quantity: (required, integer greater than 0) -# lore: (optional, list of strings) -# commands: (optional, list of console commands to execute when the item is given, can use {player} placeholder for the player's name) +# - item: (required, valid minecraft item name or Head Database ID starting with 'hdb-') +# title: (optional, string) +# quantity: (required, integer greater than 0) +# lore: (optional, list of strings) +# commands: (optional, list of console commands to execute when the item is given, can use {player} placeholder for the player's name) # reward_randomized: (optional, true/false, default is false. If true, the items will be randomized) # reward_max_items: (optional, integer, default 0 grants all items. Use in conjunction with reward_randomized to create variety of rewards) # @@ -25,8 +25,56 @@ # # {player} - The name of the player who voted # -# Be sure to enclose strings in quotes ('') if they contain special formatting codes such as & or hex colors. -# +# Be sure to enclose strings in quotes ("") if they contain special formatting codes such as & or hex colors. +# +# Examples: +# +# diamond_pack: +# reward_name: Vote Reward +# reward_items: +# - item: DIAMOND +# title: Vote Diamond +# quantity: 1 +# lore: +# - Thank you for voting! +# - '&aKeep voting for special rewards!' +# - item: AIR +# title: Console Command +# quantity: 1 +# commands: +# - effect give {player} minecraft:speed 5 1 true +# - effect give {player} minecraft:jump_boost 5 1 true +# server_celebration_pack: +# reward_name: Random Rewards for Everyone +# reward_items: +# - item: FIREWORK_ROCKET +# title: Celebration Firework +# quantity: 16 +# lore: +# - Let's celebrate our server milestone! +# - item: CAKE +# title: Celebration Cake +# quantity: 1 +# lore: +# - A delicious cake for everyone! +# - item: DIAMOND_SWORD +# title: Warrior's Blade +# quantity: 1 +# lore: +# - A powerful sword for your battles. +# - item: IRON_PICKAXE +# title: Miner's Friend +# quantity: 1 +# lore: +# - An enchanted pickaxe for your mining adventures. +# - item: GOLDEN_APPLE +# title: Golden Delight +# quantity: 3 +# lore: +# - A golden apple to keep you healthy. +# reward_randomized: true +# reward_max_items: 3 +# # ================================================================ diamond_pack: reward_name: Vote Reward diff --git a/src/main/resources/reward_triggers.yml b/src/main/resources/reward_triggers.yml index 23db06e..f8f2ea4 100644 --- a/src/main/resources/reward_triggers.yml +++ b/src/main/resources/reward_triggers.yml @@ -16,8 +16,8 @@ # trigger_threshold: (required, integer. Number of votes required to fire the trigger. 0 = fires on every vote.) # trigger_repeat: (required, true/false. Should the trigger fire every time trigger_threshold is met.) # trigger_rewards: -# - reward_id: (required, corresponds to any item from reward_items.yml) -# reward_id: (another item from reward_items.yml, add as many as you want) +# - reward_id: (required, corresponds to any item from reward_items.yml) +# reward_id: (another item from reward_items.yml, add as many as you want) # trigger_player_message: (optional, string, message to send to the player who voted) # trigger_broadcast_message: (optional, string, message to send to all players) # @@ -29,6 +29,27 @@ # # Be sure to enclose strings in quotes ("") if they contain special formatting codes such as & or hex colors. # +# Examples: +# +# player_vote: +# trigger_name: Standard Player Vote +# trigger_user: player +# trigger_threshold: 0 +# trigger_repeat: true +# trigger_rewards: +# - diamond_pack +# trigger_player_message: '&aThanks for voting, {player}! You now have {votes} votes.' +# trigger_broadcast_message: '&b{player} just voted on {service} and now has {votes} votes!' +# server_milestone_100: +# trigger_name: Server 100-Vote Milestone +# trigger_user: server +# trigger_threshold: 100 +# trigger_repeat: true +# trigger_rewards: +# - server_celebration_pack +# trigger_player_message: '&aYou''ve received a Server Celebration reward!' +# trigger_broadcast_message: '&aThe server has received another 100 votes! Time to celebrate!' +# # ================================================================ player_vote: trigger_name: Standard Player Vote diff --git a/src/main/resources/sites.yml b/src/main/resources/sites.yml index ea8cd61..659445c 100644 --- a/src/main/resources/sites.yml +++ b/src/main/resources/sites.yml @@ -14,6 +14,13 @@ # site_vote_url: (required, string. Direct link to the vote page) # site_active: (optional, true/false, default is true. Conveniently toggle the listing on/off) # +# Example: +# +# planet_minecraft: +# site_name: PlanetMinecraft.com +# site_vote_url: https://www.planetminecraft.com/server/delphicraft-minecraft-factions-smp-survival-mcmmo-rpg/vote/ +# site_active: true +# # ================================================================ planet_minecraft: site_name: PlanetMinecraft.com