DiscordCTFHelper

A powerful and customizable bot to manage and organize CTF competitions on Discord.

Table of Contents

• DiscordCTFHelper
  • Table of Contents
  • About
  • Features
  • Installation
    • Prerequisites
    • Steps
  • Usage
  • License
  • To add
  • Contact

About

DiscordCTFHelper is a Go bot built with disgo designed to streamline CTF (Capture The Flag) management on Discord servers. The bot integrates with CTFTime and provides essential features for tracking events, managing participants, and sharing updates.

Features

• Event Management: Automatically fetch and display upcoming events from CTFTime.
• Participant Management: Track team members and roles within CTFs.
• Notifications: Send reminders for upcoming events and important milestones.
• Event Archive: Organize past event details for reference.
• Customizable Status: Display real-time bot activity.

Installation

Prerequisites

• Go 1.25.5 or later
• A Discord bot token (obtainable via the Discord Developer Portal)

Steps

1. Clone this repository:

   git clone https://github.com/akiidjk/DiscordCTFHelper.git
   cd DiscordCTFHelper

2. Install dependencies:

   go mod download

3. Set up your .env file: Create a .env file in the root directory and include the following variables:

   TOKEN=<discord_token>
   LOG_LEVEL=info
   LOG_FORMAT=text
   LOG_SOURCE=false

4. Run the bot:

   go run cmd/ctfhelper/main.go

   Optional flags (dev scope):

   • --sync-commands: Sync slash commands to Discord.
   • --clean-commands: Clean existing commands from Discord.

Usage

• Invite the bot to your server using the generated OAuth2 link from the Discord Developer Portal.
• A user with admin role can run the command /init for the bot setup.
• Create a CTF with /create.

License

This project is licensed under the Apache License. See the LICENSE file for details.

Roadmap

• Add final scraping for team stats
• Add overall report generation
• New handling of channel one channel only read width the banner show
• Flag command
• Reaction cookie and fire too each flag
• Remove command
• Creds command (command for store and show the creds of a ctf)
• Send link to ctf message when channel is created
• /chall command to add challenges
• Migration to discordgo or disgo (not urgent)
• /vote to vote next ctf (incomplete)

Contact

For support or questions, feel free to open an issue or contact us directly