Runiverse Bot Documentation

Runiverse-Bot
Welcome to the Runiverse. 

One single place for all your RSPS needs, from Server-Owners, to Server-Players, or just a curious adventurer looking for that next place to call home.
With a collection of services from voting, to shopping, and with wayts to view the leaderboards, there is no place like ::1

With this bot Owners can Register their Discord Guild with their RSPS. From here you can implement our Free Services and so much more to come...

Discord Intents:

● GatewayIntent.GUILD_MESSAGES
→ Message events from text channels in guilds

● GatewayIntent.MESSAGE_CONTENT
→ This affects the messages received in the message history

● GatewayIntent.GUILD_EMOJIS_AND_STICKERS
→ Custom emoji and sticker add/update/delete events.

● GatewayIntent.DIRECT_MESSAGES
→ Message events in private channels.

SlashCommands:

Discord MANAGE_PERMISSION Commands:
→ These are commands that Discord users with MANAGE permissions can use.

/register (Discord Owner Only)
● 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
→ Successful creation will return a message with your AccessToken
→ Make note of this Token as it will be needed for the RSPS-Intigration of the Runiverse-API

/manage {sub-command}
● SubCommands
→ new-token ▸ Generates a new AccessToken for the Runiverse-API
→ get-api ▸ Receive a DM with a link to get the Runiverse-API.jar

Registration:
We create a model of your server, containing your Discord Guild ID, the Owner's Discord ID, and display name, we then present you witha forum to fill in

RuneScape Private Server information input forum:

● Server Name
→ Min 1 character; Max 72 characters

● RuneList.io TopList link
→ Min 32 characters; Max 72 characters

● Server's Website URL
→ Discords default limit for TextInputStyle.SHORT (Min 1 character; Max 4,000 characters)

● Server's Client/Launcher URL
→ Discords default limit for TextInputStyle.SHORT (Min 1 character; Max 4,000 characters)

● Server description
→ Min 32 characters, Max 180 characters

RuneVote-Bot
Welcome to RuneVote

RuneVote is a modern TopList designed for the modern RSPS Owner and Player.
This new platform for voting is itself a TopList, as well as supporting existing Legacy Voting (Browsers)

RuneVote is free to use, all you have to do is register your server on RuneList's Toplist. Amazing, isn't it?

Discord Intents:
● GatewayIntent.GUILD_MESSAGES
→ Message events from text channels in guilds

● GatewayIntent.MESSAGE_CONTENT
→ This affects the messages received in the message history

● GatewayIntent.GUILD_EMOJIS_AND_STICKERS
→ Custom emoji and sticker add/update/delete events.

● GatewayIntent.DIRECT_MESSAGES
→ Message events in private channels.

SlashCommands:

Discord MANAGE_PERMISSION Commands:
→ These are commands that Discord users with MANAGE permissions can use.

/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
↳ {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

Manage Subcommands:

● vote-rewards
→ Selecting the type to add, will present the user with an input forum for the information
↳ {in-game item} ▸ item ID, item name, amount of the item for single reward, the cost of the reward
↳ {in-game custom} ▸ Reward Key to be passed back to the server for the server-side code, Description of the reward, and a cost of this reward
→ {remove a reward} ▸ Receive a Select Menu (Drop down menu) of the rewards, select the one you wish to remove

● toplists
→ {add new} ▸ This will present the user with an Input forum for the toplist they wish to add
→ {remove} ▸ Receive a Select Menu (Drop down menu) of the toplists, select the one you wish to remove

General Public Commands:
→ These can be used by everyone

/vote {username}
✔ Required parameter
● {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
● This will present the user with a Select Menu of the Rewards registered to the RSPS
→ This is used with the Runiverse-API that is implemented on the Server-Side so that players can claim rewards for voting for servers

/info {username}
✔ Required parameter
● {username} ▸ The name of the player to lookup
→ This will return an embedded message with the User's Voting information, selected reward and it's cost, as well as general public voting infomation about the user
 

Direct Message Commands

!top-servers {amount}
→ {amount} optional ▸ This specifies the amount of top servers to display back
↳ The default is 3 if no value is passed with a max of 10

Information and Specs

Supported TopLists:
● RuneList
● RuneLocus
● Rune-Server
● RspsToplist
● Top100Arena
● TopG
● MoparScape
● RSPS-List

Specifics:

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.

Toplist input forum:
● TopList URL
→ The link that contains your server's vote button, link will be checked
→ Min 1 character; Max 75 characters

Reward In-Game ITEM forum:
● Item ID
→ Min 1 character; Max 6 characters
● Item Name
→ Min 1 characters; Max 64 characters
● Item Amount
→ Min 1 character; Max 9 characters
● Item Cost
→ Min 1 characters, Max 3 characters

Reward In-Game CUSTOM forum:
● Reward Key
→ Min 1 character; Max 32 characters
↳  This will be sent back to the API calling the method `handleCustomReward` passing in this key
● Reward Description
→ Min 1 characters; Max 32 characters
● Reward Cost
→ Min 1 characters, Max 3 characters

RuneStore-Bot
Welcome to RuneStore. 

Bringing ecomm to Discord. Simply create your store, add the stock you wish to sell, then wait for players to view your store and buy your product!

The RuneStore Checkout is compatible with PayPal only, so you will be required to have a PayPal Acccount
● If you don't have one, Sign up Today: https://www.paypal.com

Discord Intents:

● GatewayIntent.GUILD_MESSAGES
→ Message events from text channels in guilds

● GatewayIntent.MESSAGE_CONTENT
→ This affects the messages received in the message history

● GatewayIntent.GUILD_EMOJIS_AND_STICKERS
→ Custom emoji and sticker add/update/delete events.

● GatewayIntent.DIRECT_MESSAGES
→ Message events in private channels.

SlashCommands:

Discord MANAGE_PERMISSION Commands:
→ These are commands that Discord users with MANAGE permissions can use.

/manage {sub-command}
● SubCommands
→ {create} ▸ Create your Store
→ {products} {option} ▸ Manage your products in the store, {options: add, remove}

Manage Subcommands:
● create
→ This will present the user with a Store Registration Forum

● products {option}
→ {add} ▸ This will offer a Selection Menu for the Type of product to add
→ {remove} ▸ Receive a Select Menu (Drop down menu) of the products, select the one you wish to remove

General Public Commands:
→ These can be used by everyone

/shop {sub-command}
● SubCommands
→ view ▸ View the products in the Store in an embedded message
→ buy ▸ Presents a Select Menu (Drop down menu) of products to purchase, select the one you want to proceed to the checkout.

Input Forums:

Store Creation Forum:

● Store Name
→ Min 1 character; Max 64 characters
● Store Description
→ Min 1 characters; Max 128 characters
● PayPal Email
→ Min 1 character; Max 128 characters

Product Addition Forums:

DEFAULT

● Product Name
→ Min 1 character; Max 64 characters
● Product Description
→ Min 1 character; Max 64 characters
● Product Price
→ Min 1 character; Max 64 characters

ADDITIONAL BASED ON Type

Type-ITEM
● Item ID
→ Min 1 character; Max 64 characters
● Item Quantity
→ Min 1 character; Max 64 characters

Type-CREDIT
● Credit Quantity
→ Min 1 character; Max 64 characters

Type-DISCORD_ROLE
● Role ID
→ Min 1 character; Max 64 characters
* This has plans to be changed to a Select menu of non admin roles to pick from

Type-CUSTOM
● Custom Key
→ Min 1 character; Max 64 characters

RuneScore-Bot
Welcome to RuneScore. 

A HiScore/Leaderboard completes inside of Discord, search for top players, specific players, or for the top in a given skill

Discord Intents:

● GatewayIntent.GUILD_MESSAGES
→ Message events from text channels in guilds

● GatewayIntent.MESSAGE_CONTENT
→ This affects the messages received in the message history

● GatewayIntent.GUILD_EMOJIS_AND_STICKERS
→ Custom emoji and sticker add/update/delete events.

● GatewayIntent.DIRECT_MESSAGES
→ Message events in private channels.

SlashCommands:

-

General Public Commands:

/search {sub-command}
● SubCommands
→ players ▸ Search for a specific player
→ top ▸ Search for the Top X players