📖 PyroBot Documentation

Complete guide to using PyroBot for raid management and AI-powered assistance.

📋 Table of Contents

Getting Started
Initial Setup
Command Reference
Workflow Examples
User Participation
Participant Swap Command
Tips & Best Practices
AI Features & Commands

🚀 Getting Started

Prerequisites

The bot must be added to your Discord server
You need Manage Guild or Manage Roles permissions to configure the bot
The bot needs permissions to:
- Send Messages
- Embed Links
- Manage Roles
- Create Events (optional, for Discord calendar integration)

First Time Setup

When you first add PyroBot to your server, you'll need to configure:

Guild settings (timezone, limits)
Raid roles
Raid times
Raid passes
Pass assignment (REQUIRED) - Assign passes to each raid role
Participant limits (optional)

⚙️ Initial Setup

Step 1: Configure Guild Settings

Use /pyro-guild set to configure your server's basic settings.

/pyro-guild set
  timezone: Asia/Jakarta
  join_raid_daily_limit: 1
  join_raid_consecutive_day: 2
  enable_discord_events: true

Parameters:

timezone - Your server's timezone (e.g., Asia/Jakarta, America/New_York)
join_raid_daily_limit - Maximum raids a user can join per day (0 = unlimited)
join_raid_consecutive_day - Maximum consecutive days a user can raid (0 = unlimited)
enable_discord_events - Create Discord Events for raids (shows in server calendar)

View current settings:

/pyro-guild view

Step 2: Create Raid Roles

Raid roles represent different types of raids (e.g., Nightmare, Hard Mode, Normal).

/pyro-role create
  name: Nightmare Raid

Step 3: Create Raid Times

Raid times are time slots when raids can be scheduled.

/pyro-time create
  name: Evening
  time: 19:00

Time must be in 24-hour format (HH:MM) and will follow the guild timezone config.

Step 4: Create Raid Passes

Raid passes represent different participant slots (e.g., DPS, Tank, Healer, Bench).

/pyro-pass create
  name: DPS
  is_bench: false

Step 5: Assign Passes to Raid Roles (REQUIRED)

⚠️ This step is REQUIRED before you can create raid schedules!

Assign which passes users can select when joining each raid role.

/pyro-assign-pass create
  raid_role: Nightmare Raid
  passes: DPS,Tank,Healer,Bench

Step 6 (Optional): Set Participant Limits

If you want to limit how many people can join with each pass type:

/pyro-limit set
  raid_role: Nightmare Raid
  limits: DPS:10,Tank:2,Healer:3,Bench:20

📖 Command Reference

Guild Management

Command	Description	Permission Required
`/pyro-guild set`	Configure guild settings	Manage Guild
`/pyro-guild view`	View current settings	Manage Guild

Raid Role Management

Command	Description	Permission Required
`/pyro-role create <name>`	Create a new raid role	Manage Roles
`/pyro-role add <role>`	Link existing Discord role	Manage Roles
`/pyro-role list`	List all raid roles	Manage Roles
`/pyro-role edit`	Rename a raid role	Manage Roles
`/pyro-role delete`	Delete a raid role	Manage Roles

Time Slot Management

Command	Description	Permission Required
`/pyro-time create`	Create a time slot	Manage Guild
`/pyro-time list`	List all time slots	Manage Guild
`/pyro-time edit`	Edit a time slot	Manage Guild
`/pyro-time delete`	Delete a time slot	Manage Guild

Raid Pass Management

Command	Description	Permission Required
`/pyro-pass create`	Create a raid pass	Manage Guild
`/pyro-pass list`	List all passes	Manage Guild
`/pyro-pass edit`	Rename a pass	Manage Guild
`/pyro-pass delete`	Delete a pass	Manage Guild

Pass Assignment (REQUIRED)

⚠️ IMPORTANT: You MUST assign passes to a raid role before you can create schedules for that role.

Command	Description	Permission Required
`/pyro-assign-pass create`	Assign passes to a raid role	Manage Guild
`/pyro-assign-pass list`	List assigned passes	Manage Guild
`/pyro-assign-pass edit`	Replace assigned passes	Manage Guild
`/pyro-assign-pass delete`	Remove specific passes	Manage Guild

Participant Limits

Command	Description	Permission Required
`/pyro-limit set`	Set pass limits	Manage Guild
`/pyro-limit list`	List all limits	Manage Guild
`/pyro-limit delete`	Delete limits	Manage Guild

Raid Scheduling

Command	Description	Permission Required
`/pyro-raid create`	Create a new raid schedule	Any (Only User in as Vice List)
`/pyro-raid list`	List all upcoming raids	Any (Only User in as Vice List)
`/pyro-raid delete`	Delete raid(s) on a date	Any (Only User in as Vice List)

Channel Notifications

Command	Description	Permission Required
`/pyro-notification set`	Set notification channels	Manage Guild
`/pyro-notification list`	List notification settings	Manage Guild
`/pyro-notification delete`	Remove notifications	Manage Guild

🎯 Workflow Examples

Example: Setting Up a New Raid Type

Let's set up a "Nightmare Raid" that runs at 8 PM with specific pass limits.

# Step 1: Create the raid role
/pyro-role create
  name: Nightmare Raid

# Step 2: Create time slot (if not exists)
/pyro-time create
  name: Evening
  time: 20:00

# Step 3: Create passes (if not exists)
/pyro-pass create name: DPS is_bench: false
/pyro-pass create name: Tank is_bench: false
/pyro-pass create name: Healer is_bench: false
/pyro-pass create name: Bench is_bench: true

# Step 4: Assign passes to the raid role (REQUIRED)
/pyro-assign-pass create
  raid_role: Nightmare Raid
  passes: DPS,Tank,Healer,Bench

# Step 5 (Optional): Set participant limits
/pyro-limit set
  raid_role: Nightmare Raid
  limits: DPS:8,Tank:2,Healer:2,Bench:15

# Step 6: Set notification channels
/pyro-notification set
  raid_role: Nightmare Raid
  channels: #raid-announcements #general

# Step 7: Create a raid
/pyro-raid create
  date: 2025-12-15
  raid_time: Evening
  raid_role: Nightmare Raid

👥 User Participation

How Users Join Raids

Find the raid embed in the designated channel
Click the "Join" button
Select your raid pass from the dropdown menu
Confirm - You're now registered!

How Users Leave Raids

Click the "Leave" button on the raid embed
Confirm - You're removed from the raid

Viewing Participants

Click the "View Participants" button to see:

Who has joined
What pass they're using
How many slots are remaining

🔄 Participant Swap Command

Command Usage

/pyro-participant swap
  raid_date: YYYY-MM-DD
  raid: [Select from autocomplete]
  user1: @FirstUser (must be joined in raid)
  user2: @SecondUser (can be: not in raid, support, bench, or joined)

What It Does

The swap command supports four different scenarios based on User2's status:

Scenario 1: Substitution (User2 not in raid)

User1: Removed from raid
User2: Joins with User1's pass
Use case: User1 can't attend, User2 substitutes

Scenario 2: Support to Joined (User2 in support role)

User1: Removed from raid
User2: Promoted from support to joined with User1's pass
Use case: Support member takes over for absent participant

Scenario 3: Bench Swap (User2 in bench pass)

User1: Gets User2's bench pass
User2: Gets User1's active pass
Use case: Bench player moves to active roster

Scenario 4: Standard Swap (Both joined with regular passes)

User1: Gets User2's pass
User2: Gets User1's pass
Use case: Two participants swap their roles/passes

Requirements

User1 must be an active participant with 'joined' status
User2 can be:
- Not in the raid (substitution)
- In support role
- Joined with bench pass
- Joined with regular pass
Both users must have the Discord raid role for the specific raid
You must have Manage Guild permission
The raid must exist on the specified date

Features

✅ Autocomplete: Type the date and select the raid from a dropdown
✅ Smart Detection: Automatically detects the swap scenario
✅ Validation: Prevents invalid swaps (same user, wrong status, etc.)
✅ Auto-update: Raid embed automatically refreshes with new assignments
✅ Audit Log: All swaps are logged with scenario type

Example Scenarios

Example 1: Substitution

Before:

Alice: DPS (joined)
Bob: Not in raid

Command:

/pyro-participant swap
  raid_date: 2025-12-10
  raid: Nightmare Raid - 20:00
  user1: @Alice
  user2: @Bob

After:

Alice: Removed
Bob: DPS (joined) ← Substituted

Example 2: Support Promotion

Before:

Alice: Tank (joined)
Bob: Support

Command:

/pyro-participant swap
  raid_date: 2025-12-10
  raid: Nightmare Raid - 20:00
  user1: @Alice
  user2: @Bob

After:

Alice: Removed
Bob: Tank (joined) ← Promoted from support

Example 3: Bench Swap

Before:

Alice: DPS (joined)
Bob: Bench (joined)

Command:

/pyro-participant swap
  raid_date: 2025-12-10
  raid: Nightmare Raid - 20:00
  user1: @Alice
  user2: @Bob

After:

Alice: Bench (joined) ← Moved to bench
Bob: DPS (joined) ← Moved to active

Example 4: Standard Swap

Before:

Alice: DPS (joined)
Charlie: Healer (joined)

Command:

/pyro-participant swap
  raid_date: 2025-12-10
  raid: Nightmare Raid - 20:00
  user1: @Alice
  user2: @Charlie

After:

Alice: Healer (joined) ← Swapped
Charlie: DPS (joined) ← Swapped

💡 Tips & Best Practices

For Administrators

Set realistic limits - Don't make pass limits too restrictive
Use bench passes - Allow more people to participate as backups
Configure notifications - Set up multiple channels for better visibility
Enable Discord Events - Helps members see raids in the server calendar
Test first - Create a test raid to ensure everything works

For Raid Organizers

Schedule in advance - Give members time to sign up
Monitor participation - Check who's joined before raid time
Use clear naming - Make raid roles and times easy to understand
Communicate changes - If you delete/reschedule, notify participants

For Members

Sign up early - Popular passes fill up quickly
Be honest - Only join if you can actually attend
Leave if unavailable - Free up your slot for others
Check reminders - The bot will remind you before raids start

🤖 AI Features & Commands

PyroBot includes powerful AI capabilities to enhance your raid management and provide intelligent assistance.

Overview

The AI assistant can help with raid management, answer questions, and provide intelligent responses based on your guild's context and knowledge base.

 Note: AI conversational features require Supporter tier
            or higher. Free users have access to basic AI help for raid creation
            only.

AI Commands

/pyro-ai query

Ask the AI assistant any question about raids, schedules, or guild management.

/pyro-ai query [your question]

Examples:

/pyro-ai query show me the future raid list
/pyro-ai query what's the best time for a raid this weekend?
/pyro-ai query how do I create a new raid role?

/pyro-ai create-raid

Create a new raid using AI assistance. The AI will help recommend the best time slot based on your guild's schedule.

/pyro-ai create-raid
  date: [YYYY-MM-DD]
  raid_role: [role name]
  description: [optional description]

Parameters:

date - The date for the raid (required, format: YYYY-MM-DD)
raid_role - The role for the raid (required, autocomplete available)
description - Custom description for the raid (optional, max 500 characters)

Example:

/pyro-ai create-raid
  date: 2025-12-02
  raid_role: Nightmare Raid
  description: Special weekend raid with extra rewards

AI Features

Intelligent Query Handling

The AI can understand and respond to natural language queries about:

Upcoming raid schedules
Guild configuration
Raid management best practices
Bot functionality and commands

Smart Raid Creation

When creating a raid with AI assistance:

The AI analyzes your guild's existing schedule
Recommends the best available time slot
Provides reasoning for the recommendation
Creates the raid with all necessary components

AI Guild Knowledge Base

Adding your own curated Guild Knowledge for AI

Make sure your Discord Server has Supporter tier or higher
Make sure your already setup channel to send where knowledge list will be showed
use @Pyrobot add-knowledge in any channel and followed by your knowledge you wanna to save
Bot will save it and Vice should verify and mark the submitted Knowledge are valid or not for later be used as AI Knowledge
All Guild Member can access this AI Feature

Context-Aware Responses

The AI has access to:

Your guild's knowledge base
Upcoming raid schedules
Available raid roles and times
Guild settings and preferences
All Guild Member can access this AI Feature

Requirements

Appropriate permissions to use AI commands (same as other PyroBot management commands)
The guild must have at least one raid role and one raid time configured
Supporter tier for full AI conversational features

Troubleshooting AI Features

Command Not Available

If the AI commands don't appear:

Check that you have the necessary permissions
Verify you have Supporter tier for full AI features

AI Not Responding

If the AI doesn't respond to queries:

Verify your Supporter status is active
Ensure the guild has proper knowledge base entries (if applicable)

Raid Creation Issues

If AI raid creation fails:

Verify the date format is correct (YYYY-MM-DD)
Ensure the selected raid role has passes assigned
Check that there are available raid times configured

🎮 Quick Start Checklist

Configure guild settings (/pyro-guild set)
Create raid roles (/pyro-role create)
Create time slots (/pyro-time create)
Create raid passes (/pyro-pass create)
Assign passes to raid roles (/pyro-assign-pass create) - REQUIRED
Set participant limits (/pyro-limit set) - Optional
Configure notifications (/pyro-notification set)
Create your first raid (/pyro create)
Test user participation

Need More Help?

For additional questions, check out our FAQ page or join our Discord support server.