pencilCustom Vote Sites

Furthermore detailed information on how-to add a new Vote Sites.

Vote Site Setup - Custom Vote Sites

  • Step 1: If you are adding a new website, go to the website in question (Example: Minebrowse) and either send a test vote or vote on the server.

NOTICE: When a vote site sends a vote to your server for the first time/when VoteSites.yml is fresh, it will autopopulate the VoteSites.yml file with the appropriate ID's for said votesite as well as some default lines of code. The ID is the very top line of each vote site.

Example

#
  Minebrowse_com:
    Enabled: true
    Name: Minebrowse
    Priority: 1
    ServiceSite: Minebrowse.com
    VoteURL: '[Text="&e[Click Me!]",url="https://minebrowse.com/server/1234"]'
    VoteDelay: 24
    WaitUntilVoteDelay: false
    # Reset vote delay each day (for certain sites that do this)
    # Recommend: false
    VoteDelayDaily: true
    # If true, rewards can be executed offline (requires ForceOffline to be true in the reward)
    # Setting this to true will execute the reward offline while the player is offline
    # This basiclly disables offline voting if set to true, don't misinterpret this option
    ForceOffline: false
    DisplayItem:
      Material: PAPER
      Amount: 1
    Rewards:
      AdvancedPriority:
        FREE:
          Chance: 100
          RequirePermission: true
          Permission: '!votereward.premium'
          Commands:
            Console:
            - eco give %player% 4500
            - exp give %player% 250
          Messages:
            Player: '&e&lᴠᴏᴛᴇ | &7You''ve received rewards! thanks for voting!' # Here you can make a multiline player rewards message section,
                                                                                  # recommended to just use the default config and follow the exact same format.```

In the Above Instance - "Minebrowse_com" is the VoteSite ID. Make sure to remember the concept behind VoteSiteID's for later - they will be important. DO NOT CHANGE THE ID - If you do, a duplicate Vote site or in this instance, Minebrowse configuration, will be populated into your VoteSites.yml. This will make your config look messy and also make voting confusing for your users/populate dead links.

  • Step 2: When creating custom vote site configurations, you may use the already premade templates for the defaults (PlanetMC, MCServers, etc). Simply copy and paste everything below the top line and paste it over the skeleton information that autopopulates.

  • Step 3: To change the website, simply change the url found on the VoteURL line

  • Step 4: To change what the service site looks like when players type "/voteall", modify the Service Site line with the appropriate basic url.

  • Step 5: To modify the rewards, you may either modify the existing rewards to better suit your server or add rewards of your own. To add new rewards, simply add a "-" on the line below and type the command (without a slash) you want the console to execute on the player

NOTICE: This tutorial will not go over commands, please be sure you know which commands you are executing onto the player such as give, eco, exp give, etc.

  • Step 6: Make sure that as you add new vote sites and copy/paste configs across, you are modifying the Priority Line. A good rule of thumb is to number the priority in order of where the vote sites are in your config.

Last updated