INSTALLATION & QUICK START

Get your bot off the ground in minutes.

Requirements

1. Install via pip

Run the following command in your terminal. This will pull the latest version from PyPi along with its dependencies.

# Linux / MacOS
python3 -m pip install -U dopamine-framework

# Windows
py -3 -m pip install -U dopamine-framework

2. Initialise the Bot

Create a `main.py` file and utilise the custom `Bot` class. This handles everything from cog loading to intents implicitly.

import discord
from dopamineframework import Bot

bot = Bot(
    command_prefix="?",
    cogs_path="cogs",
    logging_path="logs.db", # Enable logging backend
    default_diagnostics=True,
    intents=discord.Intents.default()
)

bot.run("YOUR_BOT_TOKEN_HERE")