Installation
To install and configure NuVotifier on your Minecraft server, follow these steps:- Download the latest version of NuVotifier from SpigotMC or Github.
- Place the downloaded JAR file in the
plugins
(The same directory,plugins
, can be used for both Bukkit-based servers and proxies) folder of your Minecraft server. Refer to this guide for help. - Restart the server. The plugin will automatically be installed and activated.
The same JAR works for both proxies (Bungeecord / Velocity) and Bukkit-based servers.
Normal Bukkit-based server setup
- Open a listening port for the plugin:
Network
tab on the Fractal dashboard, and press the “Create Allocation” button to create a port.
The default port NuVotifier uses is 8192
however you can change that value to any open and unused port between 1
and 65535
.
- Label the newly-created port on the
Network
tab:
Notes
area. Do not make this the Primary port as that would be the port reserved to connect to your Minecraft server.
- Configure the port and the IP address in the configuration file
/plugins/Votifier/
and open the config.yml
file. There, modify the port
value (on line 6
at the time of writing this guide) to the port that you’ve created on the previous step.
The ip
value is by default set to 0.0.0.0
which listens to all interfaces (IP addresses) that is bound to your server. The default value should usually work, and in the case it doesn’t, change it to the IP address that was opened with the port you created in step 1.
/plugins/Votifier/config.yml
- Configure rewards (optional)
Bungeecord / Velocity Setup
We highly recommend using Velocity in place for Bungeecord to ensure your backend servers can only be accessed by your proxy. This prevents bad actors from spamming the server with votes.
- Installing the plugin:
- Installing vote listeners:
The plugin does not include listener functionality. Once the plugin is installed, you’ll need to install a vote listener plugin.
- Configuring vote forwarding
Backend Servers (Bukkit-based servers)
As we are taking a Velocity / Bungeecord approach, we need to configure vote forwarding to ensure votes are passed on from proxy to backend servers. To do this, we need to set themethod
value in the config file to use pluginMessaging
. This also means we are not passing votes through ports, rather through plugin messaging so we can disable ports in all of the backend server. This can be done by changing the port
value to -1
.
Do NOT do this part on the proxy server.
/plugins/Votifier/config.yml
Proxy Servers (Velocity / Bungeecord)
Open a port for NuVotifier in theNetwork
tab. See step 1 and 2 from the “Normal Bukkit-based Server Setup” section.
Now, moving onto the proxy configuration file, head to /plugins/Votifier
and open the config.toml
file. There, you need to input the port you’ve just created into the port
value. Furthermore, you also need to set the method
under the forwarding
section to pluginMessaging
.
/plugins/Votifier/config.toml
/server
command. You can make further modifications and changes to the way it’s setup by using NuVotifier’s guide as reference
Adding your server to a voting site
By adding NuVotifier and a rewards plugin to your Minecraft server, you can configure votes and add your server to a Minecraft server list site, like minecraftservers.org.- Register for an account at minecraftservers.org. Please ensure to use a strong password for your account!
- Once registered, and you have verified your account, press the “add a server” button on the top.
- Fill in the details of your server:
- Name: The name of your server (can be anything like “My Fractal Server” for example).
- IP/Host: The IP address / FQDN / domain of your server/
- Port: Enter the port of your Minecraft server. Default is
25565
, however it can vary on your setup. It is the 4-5 digit number beside the IP address. - Enable Votifier: Enable this if you have installed the Votifier plugin.
- Discord: Add the discord invite link to your community if you have one (optional).
- Country: Where the server / community is located (optional).
- Banner: The featured image or gif displayed on the site with your server.
- Description: What your community is about, what you offer, what makes your server unique!
- Tags: Things about your server, for example
bedwars
,smp
,skywars
,prison
, etc. - YouTube Video: Add a link to a YouTube video describing and featuring your server (optional).
- I am human: are you hooman?
- Don’t forget to “Enable Votifier”. There, enter the following information:
- IP address (the numbers before the colon).
- The port you’ve created for Votifier here.
Public Key
, copy the contents of the/plugins/Votifier/rsa/public.key
file, and paste it into the field.
Keep your private key safe! If exposed, it allows anyone, especially bad actors, to send as many votes as they’d like to your server!
- Test the system! Press the “Send Test Vote” button, and if it’s successful, you should see the plugin respond back in the server console.
You can use the commands:
/testvote
(for Bukkit-based or Sponge servers), or /ptestvote
(for Velocity / Bungeecord servers).Configure rewards
- Install a vote listener plugin
- SuperbVote
- VotingPlugin (Advanced)
- UltimateVotes (Paid)
- Enjin (Requires Enjin)
- Configure rewards on vote
/plugins/SuperbVote
and open the config.yml
file. Find the rewards
value in the file (line 50 at the time of writing, or use CTRL + F
to search) and configure the commands that are executed.
As the plugin also offers if
functionality, you can configure different players to receive different rewards depending on the permission they have.
Example
/plugins/SuperbVote/config.yml
%player%
: Player’s username.%player_uuid%
: Player’s UUID.%service%
: The service where the vote came from.%votes%
: Returns the number of votes the player has.- PlaceholderAPI placeholders.
Enable the
/vote
command for players by changing the vote-command
from false
to true
.