RuneVote Documentation

RuneVote is a Discord Bot that can be used as a voting script for RuneScape Private Servers (RSPS). Server owners can add RuneVote to their Discord Server. All they have to do is invite RuneVote, add their server information (Eg. servername and description), and add the Toplists that the player needs to vote on. Players can then use commands and buttons to vote for their favorite server and claim voting rewards. And all of that can be done through Discord. RuneVote is free to use, all you have to do is register your server on RuneList's Toplist. Amazing, isn't it?

Installation

1. Invite the bot to your server Discord.
2. Type /register
3. Setup toplists by typing /manage

Specifics

RSPS Registration

• Server name (Max 72 characters)
• Must have a RuneList.io TopList Entry to link
• Server Description (Min 32, Max 180 Characters)

TopList Links

• The URL must be a valid voting link
  • This is checked by the backend scraping the URL passed and taking multiple checks, will verify the link has a valid way to vote
  • Example is looking for a vote button within the html elements on the page.

Media

Supported Toplists

1. RuneList
2. RuneLocus
3. Rune-Server
4. RspsToplist
5. Top100Arena
6. TopG
7. MoparScape
8. RSPS-List

Commands

Discord Owner Commands:

/register

• This will register the discord that the command is executed in
  • Bringing up a form to fill out to register your RSPS with as well
  • If this popup form closes, to reopen, reenter this command

/manage {sub-command} {option}

• Subcommands
  • Vote-rewards {option}
    • {in-game item} -> Register an in-game reward for your players, providing an ItemId, Amount, Cost, and Item Name
    • {in-game custom} -> Register a Custom reward, provide a Key which will be passed to the API for you to handle Server-Side
    • {discord role} -> Register a Role on your server to have your players receive
    • {remove a reward} -> Choose a reward to remove
  • Toplists {option}
    • {add new} -> Register a TopList for your players to quickly vote on from Discord
    • {remove} -> Select a TopList to remove
  • New-token -> Generates a new AccessToken for the RV-API
  • Get-api -> Link to get the RV-API

General Public Commands:

/vote {username}

• Required parameters
  • {username} -> The players in-game name
    • This will present the user with a Select Menu, containing the list of TopLists registered to the Discord
    • The incentive is generated and attached to the `Supported TopLists`
    • The supported toplists will format and concatenate the incentive in the format for that list
    • All other TopLists are considered to be Not Supported; and it will be the VoteLink + incentive(domain.com/toplist/{sid}/vote/{incentive})

/select-reward

• No parameters
  • This will present the user with a Select Menu of the Rewards registered to the RSPS
  • This is used with the RV-API that is implemented on the Server-Side so that players can claim rewards for voting for servers

/info

• No parameters
  • Replies with an embedded message with the server name and info, as well as buttons to their website and Client/Launcher

/play

• This will give the player an Embedded message with Buttons to the Website and Client/Launcher download

Private Message Commands

!faq

• Embedded Message with Frequently Asked Questions