Configuration

The plugin's configuration file!

# VoteParty
# Creator: Clip & Glare
# Contributors: https://github.com/VoteParty/VoteParty/graphs/contributors
# Issues: https://github.com/VoteParty/VoteParty/issues
# Spigot: https://www.spigotmc.org/resources/987/
# Wiki: https://wiki.helpch.at/glares-plugins/voteparty
# Discord: https://helpch.at/discord
settings:
    # The default language of the plugin
    language: en-US
    # The prefix of all the messages in the plugin
    prefix: '&d&lVote&5&lParty &7&l» '
    counter:
        # How often to save the current amount of votes (in seconds)
        save-interval: 300
    data:
        # How often do we want to save the player data (in seconds)
        save-interval: 300
        # Do you want to save a player's data instantly on vote? This will happen along with the interval saving above.
        # Some servers just prefer to save instantly to ensure all the data is there.
        save-on-vote: false
    # Would you like to enable Brigadier command support? (I think it does more than just pretty colors) 1.13+
    brigadier: false
# The hook part of the config allows you to configure which plugins you would like to hook into for votes.
# By default, the plugin will utilize NuVotifier and listen for it's vote events.
# If you would like to use the plugin without NuVotifier, just disable the hook!
# NOTE: Keep in mind that without being hooked into a vote plugin, the plugin will not automatically handle votes.
# You will be required to do everything manually.
# Over time, more plugins may become supported!
hooks:
    # This property represents whether or not to listen to NuVotifier for incoming votes.
    # If the backend is set to true, it assumes that the NuVotifier plugin is already enabled on the backend Spigot server,
    # and pluginMessaging does not need to be enabled. If the backend is disabled, pluginMessaging should be enabled to allow
    # NuVotifier to work on the proxy server. Additionally, make sure that the channel specified here matches the one set in
    # your NuVotifier configuration, and that the "method" in your NuVotifier config is set to "pluginMessaging".
    votifier:
        backend: true
        pluginMessaging: false
        pluginMessageChannel: nuvotifier:votes
crate:
    enabled: true
    lore: 
    - ''
    - '&7Place the chest in order to'
    - '&7to receive rewards!'
    - ''
    material: CHEST
    name: '&d&lVote&5&lParty &f&lCrate'
# Configuration for particle effects you can play
# throughout different parts of the plugin
effects:
    # Configuration for particles when party commands are being executed
    party_commands_execute:
        enable: true
        effects: 
        - SMOKE_NORMAL
        - HEART
        offsetX: 0.0
        offsetY: 0.0
        offsetZ: 0.0
        speed: 0.1
        count: 2
    # Configuration for particles when a party starts
    party_start:
        enable: true
        effects: 
        - SMOKE_NORMAL
        - HEART
        offsetX: 0.0
        offsetY: 0.0
        offsetZ: 0.0
        speed: 0.1
        count: 2
    # Configuration for particles when a player votes
    vote:
        enable: true
        effects: 
        - SMOKE_NORMAL
        - HEART
        offsetX: 0.0
        offsetY: 0.0
        offsetZ: 0.0
        speed: 0.1
        count: 2
party:
    # The amount of votes needed for a party to occur
    votes_needed: 50
    # Would you like to use a crate for the rewards?
    use_crate: false
    # The list of worlds where party rewards won't be given
    disabled_worlds: 
    - ''
    # Choose to allow offline votes count towards the party
    offline_votes: true
    # There are 3 different ways that a party can work.
    # 1) "everyone" - everyone can join the party whether they voted or not
    # 2) "daily" - everyone who voted in the past 24 hours can join the party
    # 3) "party" - everyone who voted in this specific party can join the party
    # Set the mode below to one of the options above to specify how the party should function
    party_mode: everyone
    # The amount of time (in seconds) the server will wait to start the party after the amount needed has been achieved
    start_delay: 15
    # The amount of time (in seconds) the server will wait between executing reward commands
    command_delay: 1
    # Configuration for chance rewards to be given during a party.
    # Add as many commands as you want, set their chance, and choose the max amount a player can earn!
    reward_commands:
        enabled: true
        max_possible: 1
        commands: 
        - chance: 50.0
          command:
          - eco give %player_name% 100
        - chance: 50.0
          command:
          - give %player_name% DIAMOND 6
        - chance: 50.0
          command:
          - give %player_name% IRON_INGOT 12
    # Configuration for extra commands to be executed on players who have specific permission nodes when a party happens
    permission-rewards:
        enabled: true
        permCommands: 
        - permission: my.special.permission
          commands:
          - eco give %player_name% 500
    # A list of rewards that will ALWAYS be given to a player during a party
    guaranteed_rewards:
        enabled: true
        commands: 
        - eco give %player_name% 10
        - give %player_name% STEAK 8
    # Commands to be executed before a party is started
    pre_party_commands:
        enabled: true
        commands: 
        - broadcast Party will start soon!
    # Commands to be executed when a party has started
    party_commands:
        enabled: true
        commands: 
        - broadcast A Vote Party has started!
voting:
    # Would you like to validate the usernames being sent from voting sites?
    validate_names: false
    # This is the regex for username checking. The default should apply to most accounts, but you are given access to modify in case you need to.
    name_regex: ^[a-zA-Z0-9_]{2,16}$
    # This is how long (in hours) the plugin should check that it has been since a user has voted before reminding them to vote.
    reminder_interval: 24
    # This is how many votes the plugin should check that a user has in the last X amount of time (defined above) before reminding them to vote.
    # For example, if you set the reminder interval to 24 hours, and the reminder threshold to 3, the plugin will check if the user has voted 3 times in the last 24 hours.
    # If they have, they will not be reminded to vote until they have voted 3 times in the last 24 hours.
    reminder_threshold: 3
    # How often in seconds should players be reminded to vote? (Default is 10 minutes)
    # Note: A FULL reboot is required for this to take effect if changed after the plugin has been loaded.
    reminder_interval_seconds: 600
    # If a player's inventory is full when voting, do you want to send the vote to a /vote claim?
    claim_if_full: true
    # Configuration for chance rewards to be given for voting.
    # Add as many commands as you want, set their chance, and choose the max amount a player can earn!
    per_vote_rewards:
        enabled: true
        max_possible: 1
        commands: 
        - chance: 50.0
          command:
          - eco give %player_name% 100
        - chance: 70.0
          command:
          - give %player_name% STEAK 10
    # Configuration for extra commands to be executed on players who have specific permission nodes
    permission-rewards:
        enabled: true
        permCommands: 
        - permission: my.special.permission
          commands:
          - eco give %player_name% 500
    # A list of rewards that will ALWAYS be given to a player for voting
    guaranteed_rewards:
        enabled: true
        commands: 
        - eco give %player_name% 10
        - give %player_name% STEAK 8
    # A list of commands to run when it's the first time a player has voted (only works for online players)
    first_time_rewards:
        enabled: false
        commands: 
        - eco give %player_name% 100
        - give %player_name% STEAK 10
    # Configuration for extra commands to be executed on players who voted on a specific website (only works for online players)
    # Known Service Names:
    # TopG.com
    # PlanetMinecraft.com
    # Minecraft-MP.com
    # MinecraftServers.org
    # Minecraft-Server.net
    votesite-rewards:
        enabled: false
        votesiteCommands: 
        - serviceName: TestVote
          commands:
          - eco give %player_name% 500
    # Global commands (such as a broadcast message) to be executed when a player votes
    global_commands:
        enabled: true
        commands: 
        - broadcast %player_name% just voted! Only %voteparty_votes_required_party% more votes
          until a VoteParty!
    offline_vote_claiming:
        # Would you like players to be able to claim rewards for offline votes?
        # Note: They will only be able to get credit for rewards if you have `offline_votes` enabled
        enabled: false
        # Would you like to notify the player when they login that they have votes to claim?
        notify: false
    # Configuration for extra commands to be executed on players who have voted a specific amount of times in the past day, week, month, year, and all time.
    cumulative-rewards:
        daily:
            enabled: false
            entries: 
            - votes: 5
              commands:
              - give %player_name% STEAK 10
        weekly:
            enabled: false
            entries: 
            - votes: 5
              commands:
              - give %player_name% STEAK 10
        monthly:
            enabled: false
            entries: 
            - votes: 5
              commands:
              - give %player_name% STEAK 10
        yearly:
            enabled: false
            entries: 
            - votes: 5
              commands:
              - give %player_name% STEAK 10
        total:
            enabled: false
            entries: 
            - votes: 5
              commands:
              - give %player_name% STEAK 10