A fully fledged Old School Runescape Discord bot that allows for the entire clan experience!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Every Old School Runescape clan needs a way to keep track of members' progress that feel meaningful. It always is a pain to go to another website just to check who get new achievements or to manually keep track of clan points via a ticketing system that feels archaic. That's where Wise Old Bot comes in.
Here's an overview of features available:
- Built in clan point management and speed tracking
- Discord slash commands for clan members that allow for clan point & speed submissions
- Admin slash commands for clan administration
- Guide slash commands for guide addition/modification
- Integration with third-party Runescape metrics websites such as TempleOSRS and Collectionlog.net
- Leaderboards/Hall Of Fame based off of these metrics
- Automatic Clan Point addition based off the Better Discord Loot Logger plugin on Runelite
- Feedback Discord Channel that populates when a decision has been made about a submission
- Audit Logs Discord Channel that populates with admin actions and errors
The programming language used to build Wise Old Bot is Golang. It leverages a well documented and robust library from bwmarrin called discordgo.
To get a local copy up and running follow these simple example steps.
You need to have Golang installed on your computer. For instructions on how to download, click the following link to go to the go download and installation instructions:
You will also need the following third party applications:
- Discord Bot created for this project
- Google account that all the admins will have access to
- Pastebin account that all the guide admins will have access to
- TempleOSRS group that all the members will be added to
- Imgur account that all non-imgur user submissions will be uploaded to
- Postman for Imgur Setup and ease of API testing
Below is an example of how you can start installing and setting up the Wise Old Bot.
- Clone the repo
git clone https://github.com/jlee513/wiseoldbot.git
- Create a Discord Bot Account that will be used to handle all of your requests. The following URL describes how to do that step by step.
https://discordpy.readthedocs.io/en/stable/discord.html
- You want to create an individual Google Sheets for each of the following purposes. Each of your sheets must have their share settings set to Anyone With The Link as an editor. Each of the sheets need to follow a particular structure and header as defined under each of the sheets.
Members: Player | Discord ID | Discord Name | Feedback | Main Clan Points: Player | Clan Points Clan Points Submission Screenshots: Time Submitted | URL | Player Speed Times: Category | Boss Name | Time | PLayers | URL Speed Times Submission Screenshots: Time Submitted | URL | Boss Name | Time | PLayer Transaction ID: Nothing is needed for the transaction ID sheets page. It will populate cell A1.
- Register an Imgur Application following the steps outlined in the Imgur API docs
https://apidocs.imgur.com/
- Create client_secret.json file under the config folder of this project. Follow the instructions in the following URL:
https://help.talend.com/r/en-US/8.0/google-drive/oauth-methods-for-accessing-google-drive
- Create a .env file under the config folder of this project. Look under example/.env_test for an outline of all the current environment variables that are required to run the bot.
Temple Information: TEMPLE_GROUP_ID=The Unique identifier for your clan TEMPLE_GROUP_KEY=The main key used to update clan members
Google Sheets: SHEETS_CP=Sheets ID for clan points SHEETS_CP_SC=Sheets ID for clan points screenshots SHEETS_SPEED=Sheets ID for speed times SHEETS_SPEED_SC=Sheets ID for speed times screenshots SHEETS_TID=Sheets ID for transaction id SHEETS_MEMBERS=Sheets ID for members
Imgur Information: IMGUR_CLIENT_ID=ID of your imgur client IMGUR_CLIENT_SECRET=Secret of your imgur client IMGUR_REFRESH_TOKEN=Refresh Token used to get access tokens for uploaded imgurs
Pastebin: PASTEBIN_USERNAME=Username of your Pastebin account PASTEBIN_PASSWORD=Password of your Pastebin account PASTEBIN_DEV_API_KEY=To get your dev api key, login to Pastebin and navigate to the API tab. Here, you can find a section called "Your Unique Developer API Key" PASTEBIN_MAIN_PASTE_KEY=Pastebin key id that will hold a list of your guides
Discord Channels: DISCORD_*_CHANNEL=Discord Channel ID - Compile and run the bot
go run .
When you add the bot, ensure that the admin and guide channels are locked behind roles and locked behind specific discord channels so that not everyone is able to use them.
When you have a community discord, you have the ability to create Forums which is a great way to condense sections for leaderboards, hall of fame for kcs and speed, as well as guides.
Whenever the bot posts to a discord channel, it removes all messages from the channel before posting. To ensure that the picture in Forum posts do not get deleted, make sure to use the picture upon creation of the post. This allows the bot to know that it should delete all messages after the picture.
Create one pastebin that will serve as the holder of the keys as well as the discord channel it will populate. The following will illustrate what this file should look like.
# Tob
Tob Fives - xxxxxxxx - 8648323223567591832
Tob Fives - xxxxxxxx - 8648323223567591832
Tob Fives - xxxxxxxx - 8648323223567591832
Tob Fives - xxxxxxxx - 8648323223567591832
# CM Trio
CM Trio Prep - xxxxxxxx - 8648323223567591832
CM Trio Chin - xxxxxxxx - 8648323223567591832
CM Trio Surge - xxxxxxxx - 8648323223567591832
CM Trio Useful Info - xxxxxxxx - 8648323223567591832Help: The # denotes the overall guide and each line under it will be it's own unique discord channel. Within these lines, the first will be a human readable name that isn't used in the creation of the guide - it's more for you to know what this page is for. The x's is the pastebin key which you can find in the URL when you go to a pastebin. The last number is the channel ID that you want the guide to populate in.
For information about guides, please refer to the Wise Old Bot Guide Creation Instruction
When it comes to players, we know that many people can have an account that they mainly play but also have alts. There is a feature that allows you to combine the KCs & Clan Points under one main username so that it tracks you as a player instead of individual accounts separately.
In this example above, the clan points and speed times will be tracked under the player "Mager". However, since "sry lil bro" is in the clan but is not the main, all speed times/clan points/kcs will be added and displayed under "Mager".
It is nice to see whenever something either goes wrong with the bot or an admin invoked a particular command. All error logs as well as admin invoked commands are sent off to the audit logs discord channel. All admin actions document the command invoked, all options supplied with the command, and who invoked it. All error logs document who invoked it as well as the error message.
Once a successful submission is submitted as shown above, a message will pop up in a designated hidden channel meant for only moderators. You can approved/denied using the ✅ or ❌ buttons at the bottom. Once selected, the message will be removed from the channel and will send feedback to the appropriate feedback channel of the submitter.
A feedback channel will be created if it's the first time someone has submitted. It will create a channel with only that person as well as the moderators. This is the place that is used to discuss why a submission was accepted/rejected as well as serves a history of all submissions for the user.
Once a successful submission is submitted as shown above, a message will pop up in a designated hidden channel meant for only moderators. You can approved/denied using the ✅ or ❌ buttons at the bottom. Once selected, the message will be removed from the channel and will send feedback to the appropriate feedback channel of the submitter.
A feedback channel will be created if it's the first time someone has submitted. It will create a channel with only that person as well as the moderators. This is the place that is used to discuss why a submission was accepted/rejected as well as serves a history of all submissions for the user.
Guide Updates Command
- Update: Updates the guide selected
Required Options: option, guideNote: This autopopulated guide list is updated by the /admin guides-map command based off of the main pastebin.
Player administration commands
- Add: Add player to the clan (automatically adds to temple)
Required Options: option, name, discord-id, discord-name, main
- Remove: Remove player from clan (automatically removes from temple)
Required Options: option, name
- Name Change: Moves player information from one name to another
Required Options: option, name, new-name
- Update Main: Updates the main username tracking for a player
Required Options: option, name, new-nameSpeed administration commands
- Add: Adds a new speed time under an existing category
Required Options: option, category, new-boss
- Remove: Removed a speed time under an existing category
Required Options: option, category, existing-boss
- Update: Updates the speed time, player names, or the image for an existing boss
Required Options: option, category, existing-boss
Optional Options: update-speed-time, update-player-names, imgur-url
- Reset: Resets the speed time for an existing boss
Required Options: option, category, existing-bossNote: category and existing-boss autopopulates based on the speed sheets list.
Leaderboard administration commands
- Update: Updates the leaderboard selected
Required Options: option, leaderboard, threadNote: leaderboard and thread autopopulates which is hardcoded.
Google Sheets administration commands
- Update: Updates the google sheet based on the maps/arrays stored in memory
Required Options: optionUpdate clan points and speed submission instructions
- Update: Update the clan points and speed submission instructions from code
Required Options: optionUpdate map of guides from the main pastebin
- Update: Update map of guides from the main pastebin
Required Options: optionUpdate points of the comma separated list of players
- Add: Adds the specified number of clan points
Required Options: option, player, amount-of-pp
- Remove: Removes the specified number of clan points
Required Options: option, player, amount-of-ppSee the trello board for a roadmap on what's to do and what's in progress.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Joshua Lee - @MagerOsrs
Project Link: https://github.com/jlee513/wiseoldbot