Runebot

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

Introduction

Runebot is a feature-rich Discord tool which scrapes, pulls and displays information about Old School RuneScape. Built with Python, SQLite and Beautiful Soup 4.

Try the live version of Runebot by clicking here and inviting a live instance to your server.

Key Features

Search for items and equipment, activities, bosses and more directly on discord.
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.8 +
Poetry (or the pip package management tool.)

Tools

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:

Clone the repository. git clone https://github.com/tarranprior/runebot.git
Navigate to the project folder. cd runebot
Install the dependencies:
```
poetry install
```
Alternatively, you can install the dependencies using pip:
```
pip install -r requirements.txt
```

Setup

Create an application at Discord Developer Portal. Build a bot, and copy the token.
Invite the bot to your server/guild.
Update the values in configuration.
Run the bot:
```
poetry run python src/main.py
```

Configuration

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

BOT_TOKEN = 'YOUR_BOT_TOKEN'
BOT_OWNER = 'YOUR_USER_ID'

Optional: Update the activity in config.json.

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

Usage

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.

tarranprior/runebot