Quick Start

Get JamBot running in your Discord server with these simple steps.

Prerequisites

• Python 3.11+
• Discord Bot Token (Setup Guide)
• Spotify API Credentials (Setup Guide)
• Docker (optional, for containerized deployment)

Installation

1. Clone the Repository

git clone https://github.com/asachs01/jambot
cd jambot

2. Install Dependencies

pip install -r requirements.txt

3. Configure Environment

cp .env.example .env
# Edit .env with your Discord and Spotify credentials

4. Run the Bot

python -m src.main

Configuration via Discord

Once your bot is running, configure everything directly in Discord:

1. Get User IDs: Use /jambot-getid @username to get Discord user IDs
2. Configure Essential Settings: Run /jambot-setup (admin only) to configure:
   • Jam leader user IDs (comma-separated)
   • Song approver user IDs (comma-separated)
   • Spotify Client ID
   • Spotify Client Secret
3. Authorize Spotify: Run /jambot-spotify-setup to connect your Spotify account
4. Configure Advanced Settings (Optional): Run /jambot-settings to set playlist channel and name template

Demo

See JamBot in action:

Docker Deployment

For containerized deployment:

docker-compose up -d

View logs:

docker-compose logs -f jambot

Cloud Deployment

Deploy to DigitalOcean App Platform with one click:

See the Deployment Guide for detailed instructions.

Next Steps

• Configure Discord Bot
• Set up Spotify Integration
• Learn about the Admin Workflow