Runebot

Introduction • Features • Prerequisites • Tools • Disclaimer • Installation • Usage • Support • License

Introduction

Runebot is the modern RuneScape companion for your Discord server. Invite the live version here.

Key Features

• Manage your RuneScape accounts and view stats directly from Discord.
• Search for items and equipment, activities, bosses and more.
• Get the most up to date information - directly from the official api and wiki.
• Full support of slash commands and the latest developer tools.
• Autocomplete suggestions for all applicable interactions.
• Display the latest price analytics and trends with data visualisation.
• Integration of UI/UX components (buttons, dropdowns etc.)

Prerequisites

• Python 3.10 +
• Poetry (or the pip package management tool.)

Tools

• Disnake API Wrapper
• Beautiful Soup 4
• Color-thief-py
• Matplotlib - Data Visualisation
• aiosqlite
• Humanfriendly
• Boto3

Disclaimer

The Old School RuneScape Wiki, also known as the OSRS Wiki and previously known as the 2007Scape Wiki, is the official wiki for the MMORPG game Old School RuneScape developed and published by Jagex Ltd.

RuneScape and RuneScape Old School are the trademarks of Jagex Limited and are used with the permission of Jagex.

Installation

Preferably, you should use Poetry to run this bot for local development:

1. Clone the repository. git clone https://github.com/tarranprior/runebot.git

2. Navigate to the project folder. cd runebot

3. Install the dependencies:

   poetry install

   Alternatively, you can install the dependencies using pip:

   pip install -r requirements.txt

Setup

1. Create an application at Discord Developer Portal. Build a bot, and copy the token.

2. Invite the bot to your server/guild.

3. Update the values in configuration.

4. Run the bot:

   poetry run python src/main.py --env development

Configuration

1. Update the values in .env.EXAMPLE and rename to .env.

   BOT_TOKEN = 'YOUR_BOT_TOKEN'
   BOT_OWNER = 'YOUR_USER_ID'
   
   DB_PATH = './runebot.db'
   RUNEBOT_INTERNAL_LOGS_DB_PATH = './runebot-logs-dev.db'
   
   RUNEBOT_INTERNAL_API_TOKEN = 'SET_A_LONG_RANDOM_SECRET'
   RUNEBOT_INTERNAL_API_HOST = '127.0.0.1'
   RUNEBOT_INTERNAL_API_PORT = '8080'

2. Optional: Update the activity in config.json.

   {
       "activity": "/wikipedia | RuneBot",
   }

Local development loads these values from .env and runs with --env development. Production runs with --env production and loads the bot token, database path and internal API configuration from AWS.

Support

If you have any questions about this project, please submit an issue here.

License

This project is licensed under the CC BY-NC-SA 3.0 License - see the LICENSE file for details.