Skip to content

Adding VoteSites

Ben edited this page Oct 10, 2020 · 33 revisions

See the default here

Creating VoteSite:

  • Vote on website, will cause file to be autocreated
    • SiteName will be the service site by default
    • Service site will also be set (No need to do that manually)
  • Create site manually, take a look at the VoteSites.yml
  • Create ingame, /av gui (Middle click votesites)

Configuration:

  • Define rewards: Anything in the example reward files can be put under Rewards

  • Enable the votesite and your all good to go

  • Name - Display name

  • VoteDelay is how often you can vote, this won't prevent votes but is used for stuff like /vnext

  • VoteDelayDaily - For those certain sites that need this

  • Item - Item to be disabled in certain GUI's (Will be a warning if this doesn't exist)

  • Priority - For sorting sites in the list (order they are shown)

  • VoteURL - URL in /vote or GUI's, highest priority is first

  • ServiceSite - This is how the plugin determines which voting site matches the one in the config, won't work if incorrect

  • GiveOffline - Execute rewards while player is offline (Otherwise not waiting until player is online)

      # Enable voteSite
      # If false, votesite will not be loaded by plugin
      # Default: false
      Enabled: false
      
      # Display name of voting site
      Name: 'ExampleVoteSite'
            
      # Priority of this site
      # Used for sorted list
      # High prority, higher on the list
      Priority: 5
            
      # The serviceName from the vote, has to be correct to work correctly
      # Gotten from voting on the site (will be in console/log)
      # Usually is the main part of the url(e.g. PlanetMinecraft.com)
      ServiceSite: 'PlanetMinecraft.com'
    
      # vote url for /vote
      # Format for this can be set in Format.yml
      # Do not include colors here
      VoteURL: 'link to vote URL here, used in /vote'
    
      # Time between votes in hours (used for /vote next)
      # Most sites are 24 hours
      VoteDelay: 24
      
      # Reset vote delay each day (for certain sites that do this)
      VoteDelayDaily: false
      
      # If true, rewards can be executed offline (required ForceOffline to be true in the reward)
      GiveOffline: false
      
      # VoteSite Material for GUI's
      Item:
        Material: 'DIAMOND'
        Amount: 1
    
      # Rewards to give
      # https://github.com/Ben12345rocks/AdvancedCore/wiki/Rewards
      Rewards:
        Commands:
        - 'say hello'
        Messages:
          Player: 'You voted'
    

Extra Notes:

  • Reward files are created if you directly define the reward (Meaning you didn't use a file) only if needed (examples: delaying a reward, offline reward, etc)
  • Service sites must be correct in order to work
  • Follow yml rules
Clone this wiki locally