RuneScape Discord bot

Commands

!help - Display this help text

/wiki - Get a runescape wiki link. Usage: /wiki Dragon Rider Lance

!profiles - Get the profiles of every account in the server. Reads nicknames. Separate your usernames with |.

!level - Get the level for a user's skill. Arguments: username skill

!maxed - Get a player's progress towards max. Arguments: username

!!maxed - Get an osrs player's progress towards max. Arguments: username

!portables - Returns the portables spreadsheet URL

!ge - Gets the item price. Usage: !ge dragon rider lance

!vis - Returns the link to the current vis wax combo.

!vos - Returns the current active voice of seren in Priffidnas.

!tex - Converts latex into images. Useful for sharing math formulas. Arguments: latex text

!calc - Answers questions using Wolfram Alpha. Useful for doing math. Arguments: your question

!wolfram - Returns a picture with information from Wolfram Alpha. Arguments: question

Tokens

Discord

The bot requires a token from Discord to connect. Log in at https://discord.com/developers/applications and create an Application. This application will be the bot's user.

Client ID: Go to https://discord.com/developers/applications/BOT-ID-HERE/information and copy the CLIENT ID. Set it as DISCORD_BOT_CLIENT_ID in the .env file.

Token: Go to https://discord.com/developers/applications/BOT-ID-HERE/bot and copy the token. Set it as DISCORD_BOT_TOKEN in the .env file.

Wolfram Alpha

To use the !calc and !wolfram commands, get a Wolfram Alpha token as well and set it as WOLFRAM_ALPHA_APP_ID in the .env file.

Create a free account at https://products.wolframalpha.com/api/ and copy the App ID.

Deploying

Basic: The first time, run npm install, then npm build. Then create/edit the .env.production.local file and add the required tokens/keys shown in .env. Finally, run with npm run start.

Kubernetes: Use the ./deploy/kubernetes/ yaml files. First edit and apply the rsbot-secrets.yaml, then apply either the rsbot-pod.yaml or rsbot.yaml. The former is only a pod, the latter is a kubernetes deployment. You probably want the deployment.

Docker compose: Use the ./deploy/docker-compose/ files. First edit the .env, then run docker-compose up -d.

Contributing

Running

Requires NodeJS version 12 or more.

Get a discord bot token and client ID and set them in a .env.development file. Start npm run dev.

Structure

RuneScape API stuff related calculations go in src/runescape.
Discord bot stuff and commands go in src/discord.

Discord commands are in src/discord/messageHandler. They can all contribute help text for the help command by exporting a HelpProvider.
Enablign a bot and it's HelpProvider is done in src/discord/index.ts

References

Discord

Page	Description
https://discordjs.guide/creating-your-bot/#creating-the-bot-file	Discord bot docs

RuneScape

Page	Description
https://runescape.wiki/w/Application_programming_interface	RS APIs
https://runescape.wiki/w/Module:Exchange/Abyssal_whip	Wiki GE page
https://runescape.wiki/w/Module:Exchange/Abyssal_whip?action=raw	Raw data, for programs
https://services.runescape.com/m=itemdb_rs/api/catalogue/detail.json?item=32092	Official Grand Exchange prices as json
https://apps.runescape.com/runemetrics/quests?user=USERNAME	RuneMetrics quests
https://apps.runescape.com/runemetrics/profile?user=USERNAME&activities=0	RuneMetrics profile
https://secure.runescape.com/m=website-data/playerDetails.ws?membership=true&names=[%22USERNAME%22]&callback=angular.callbacks._1&_=1448901242774	RuneMetrics player clan info
https://apps.runescape.com/runemetrics/images/skill-icons/woodcutting.png	Skill icons
https://secure.runescape.com/m=avatar-rs/USERNAME/chat.png	returns 302 to a user avatar
https://secure.runescape.com/m=avatar-rs/USERNAME/ownclan.png	returns a 302 to a clan avatar
https://apps.runescape.com/runemetrics/xp-monthly?searchName=USERNAME&skillid=SKILL_ID	Monthly xp
https://runescape.wiki/api.php?action=query&format=json&meta=allmessages&ammessages=VoS&amlang=en-gb&formatversion=2	Voice of Seren