BEACON Documentation

BEACON is a Discord bot designed to help manage support tickets efficiently. This guide outlines how to use BEACON's commands and features.

Getting Started

  • BEACON operates through Discord slash commands.
  • To view available commands, type / in a Discord chat and search for BEACON's commands.
  • Only users with the necessary roles will have access to certain administrative commands.

Ticket Management Commands

Creating a Ticket

  • Use /support to create a support ticket.
  • You will be prompted to enter a reason for your ticket.
  • Once created, a private ticket channel will be opened where you can communicate with the support team.

Managing Tickets

  • /manage action:claim - Claim a ticket to indicate that you are handling it.
  • /manage action:unclaim - Unclaim a ticket if you are no longer handling it.
  • /manage action:transfer user:@username - Transfer the ticket to another staff member.

Closing a Ticket

  • Once the issue is resolved, a ticket can be closed by an authorized staff member.
  • Closing a ticket will remove access to the channel and archive its contents.

Administrative Commands

Setup

  • /setup - Run the guided setup process to configure BEACON for your server.
  • Admins must specify logging channels, ticket categories, and staff roles.

Configuration

  • /config - Open an interactive UI to customize BEACON's settings.
  • Admins can modify settings such as ticket categories, auto-responses, and permissions.

User Profiles

Managing User Access

  • /profile action:block user:@username - Block a user from creating tickets.
  • /profile action:unblock user:@username - Unblock a user, allowing them to create tickets again.
  • /profile action:view_history user:@username - View a user’s ticket history.

Templates

Using Pre-Defined Responses

  • /templates action:send name:TEMPLATE_NAME - Send a pre-configured response.
  • /templates action:view name:TEMPLATE_NAME - View the contents of a saved template.
  • /templates action:list - List all available response templates.

Additional Features

Viewing Ticket Status

  • /status - Display a summary of all active tickets.
  • Shows tickets that require staff attention.

Notes System

  • /notes action:add note:MESSAGE - Add a note to a ticket.
  • /notes action:remove - Remove an existing note from a ticket.