Skip to main content

Faculty Bot Documentation

Streamline your university or school Discord server with automated student verification, XP tracking, and announcement management.

Get StartedView Commands
Student Verification
Automated Email System
Engagement
XP & Leveling System
Automation
RSS & Meal Plans

Quick start

Get Faculty Bot running on your Discord server in three steps.

1

Set up your environment

Create a Discord application and configure your environment variables. You’ll need a Discord bot token, PostgreSQL database URL, and SMTP credentials for email verification.
# Clone the repository
git clone https://github.com/rndrmu/faculty-bot.git
cd faculty-bot
2

Configure your server

Edit config.json to set up channel IDs, role IDs, and automation settings for your Discord server.
{
  "roles": {
    "staffrole": "YOUR_STAFF_ROLE_ID",
    "verified": "YOUR_VERIFIED_ROLE_ID"
  },
  "channels": {
    "logs": "YOUR_LOGS_CHANNEL_ID",
    "greetings": "YOUR_GREETINGS_CHANNEL_ID"
  }
}
3

Deploy with Docker

Launch the bot using Docker Compose for the easiest deployment experience.
docker-compose -f docker-compose.yml --env-file .env up
The bot will automatically register slash commands and start listening for events. Students can now use /verify init to begin verification.

Explore features

Discover what Faculty Bot can do for your server.

Student verification

Automated email-based verification system ensures only real students access your server

XP system

Gamify engagement with an XP and leveling system that rewards active participation

Moderation tools

Pin messages, manage users, and control your server with role-based permissions

Automation

Automatically post meal plans, RSS feeds, and announcements on schedule

Resources

Everything you need to deploy and customize Faculty Bot.

Installation guide

Step-by-step instructions for installing Faculty Bot using Docker, manual setup, or systemd

Read the guide

Configuration reference

Complete reference for config.json including channels, roles, and automation settings

View configuration

Command reference

Explore all available user, admin, and moderation commands with examples

Browse commands

Development guide

Learn how to contribute, add custom commands, and extend Faculty Bot

Start developing

Ready to get started?

Deploy Faculty Bot to your Discord server in minutes and start automating your faculty management today.

Get StartedView on GitHub