paperclipGuidance

Step-by-step to modify your VotingLinks.yml

triangle-exclamation

Installing the Plugin

Before Continuing: It is assumed that you have installed the below requirements, have set up your vote sites, and know where to find things such as your public voting key and other VotingPlugin information. If you do not, please read through the VotingPlugin Setup Documentationarrow-up-right

Requirements

You MUST have the following plugins

  • Luckperms: This will handle designating certain permission for your shop, by default the primary permission in designates is the voter.premium permission

  • Deluxe Menus: Necessary for access to the custom voting GUI's/Transactions

  • Placeholder API: This handles all of the behind the scenes such as the fancy texts within menus/making the buttons work appropriately within said menus/making

  • VotingPlugin: This is for setting up voting websites as well as their associated rewards.

  • PlayerPoints: This is a completely separate currency and it is required - By default it is the currency you use Vote Coins to buy and is used to buy items such as Voter Premium.

IT IS ASSUMED YOU WILL HAVE THESE INSTALLED BEFORE BEGINNING THE BELOW STEPS - PUT ALL OF THE JARS INTO YOUR SERVERS PLUGIN FOLDER AND RESTART YOUR SERVER BEFORE MOVING FORWARD -

Initial Installation

  • Step 1: After buying the configuration, download them from your BuiltByBit Licenses Page

  • Step 2: After downloading, unzip the files and find the folder which matches your server's version

  • Step 3: Inside of this version folder you will see two others - DeluxeMenus & VotingPlugin; Overwrite the contents of your own DeluxeMenus & VotingPlugin folders with these

WARNING: Doing so will completely overwrite the files you currently have - ensure you have backups before doing so.

  • Step 4: Restart your server to apply the changes

NOTICE: While reloading the plugins may also work, this can cause memory leaks and data corruption in some cases and is not recommended.

Vote Site Setup - The Defaults

  • Step 1: Go to your Voting Plugin/Config.yml and make sure that you have the following line set to true

AutoCreateVoteSites: true

  • Step 2: Go to your Voting Plugin/VoteSites.yml and look at the examples given - if you have any of these websites linked to your server, you may use the examples and paste your information into them.

NOTICE: These example vote sites do not have appropriate Voting ID's currently. When you send a test/real vote to your server, a skeleton config will be made. Simply copy the skeleton config's VoteSite ID and paste it over the top of the incorrect one. Then delete the autopopulated information. For more information on VoteSite ID's continue to the Custom Vote Sites portion of this documentation

In Game Testing

When you are in game, type /vote and voila - You have successfully opened the voting GUI. Look around and enjoy what has been provided. To customize this setup further for your servers needs, please continue to the Customization Tutorial Pages.

Last updated