🎫 Discord Ticket Bot

🎫 Discord Ticket Bot

A modern, self-hosted Discord ticket bot built on Discord.js v14 and SQLite — no external database, no telemetry, full feature set out of the box.

✨ Features

Feature	Description
🎫 Ticket Types	Up to 25 configurable types with individual emoji, color, category & questions
📋 Questionnaires	Modal forms (up to 5 questions) shown when opening a ticket
🙋 Claim System	Staff can claim/unclaim — button toggles, embed & topic update automatically
🔴 Priorities	Low / Medium / High / Urgent via `/priority` — shown in channel topic & embed
📝 Staff Notes	Private notes via `/note add` / `/note list`
🔀 Move Ticket	Move to a different type/category via `/move` or button (staff only)
🛡️ Type-specific Staff Roles	Each ticket type can define its own staff roles
🖼️ Panel Logo & Banner	Optional logo thumbnail and/or banner image in the panel embed
🎛️ Panel Interaction Type	Choose between a Button or a direct Select Menu in the panel
⭐ Rating System	1–5 star feedback after closing, automatically posted to a configured channel
⏰ Staff Reminder	Automatic ping inside the ticket if no staff responds within X hours
⏰ Auto-Close	Automatically close inactive tickets with a configurable warning period
🔗 Transcript Links	Transcripts stored online and accessible via a public link
📄 HTML Transcript	Full self-contained HTML transcript — avatars embedded as Base64, no CDN required
🌐 Custom Domain	Premium users can serve transcripts under their own domain
📊 Statistics	Server-wide stats and detailed per-user stats via `/stats`
🚫 Blacklist	`/blacklist add/remove/list` to block users from opening tickets
💬 Canned Responses	Pre-defined snippets sent with one command — configured in `snippets.jsonc`
🔒 Ticket Lock	Lock/unlock a ticket to prevent the user from sending messages
📢 Broadcast	Send a message to all open ticket channels at once
🔔 User Notifications	Optional DM notification for users when a staff member replies
🎮 Dynamic Bot Status	Automatically display the number of open tickets in the bot status
🌍 Multilingual	German and English included, easily extensible
🗄️ SQLite	No external database required — file is created automatically
🔄 Auto-Update Check	Checks for new GitHub releases on startup and notifies with update instructions

🔗 MSK Transcript Service

Instead of sending transcripts as file attachments via DM, the bot can upload them to www.msk-scripts.de and generate a public link — accessible in any browser, no download required.

Subscription Tiers

Feature	Basic (free)	Premium (€5/mo)	Premium+ (€10/mo)
Transcript as link	✅	✅	✅
Max. transcript size	10 MB	100 MB	250 MB
File attachments in transcript	❌	✅	✅
Max. attachment size per ticket	—	150 MB	500 MB
Custom domain	❌	✅	✅
Storage duration	30 days	60 days	90 days

Premium and Premium+ are unlocked via GitHub Sponsors.

Getting your API Key

Visit www.msk-scripts.de/verify
Sign in with your GitHub account
Connect your Discord account
Select your server → your API key is generated instantly

Then add it to your .env:

MSK_API_KEY="your_api_key_here"
MSK_API_URL="https://www.msk-scripts.de"

Custom Domain (Premium & Premium+)

Premium users can serve transcripts under their own domain (e.g. tickets.yourserver.com).

Visit www.msk-scripts.de/dashboard after verifying
Enter your domain and set a DNS A-Record pointing to the server IP shown
Click "Check DNS" once propagation is complete — SSL is set up automatically

📖 Full setup guide: docu.msk-scripts.de

💖 Sponsors

Thank you to everyone who supports this project!

📁 Project Structure

discord_ticketbot/
├── index.js                    # Entry point
├── package.json
├── .env.example                # Environment variable template
├── ticketbot.service           # systemd unit file for Linux servers
├── assets/                     # Static files (logo, banner images)
│   ├── logo.png
│   └── banner.png
├── config/
│   ├── config.example.jsonc    # Configuration template (with comments)
│   └── snippets.example.jsonc  # Canned responses template
├── docs/
│   ├── setup-en.md
│   └── setup-de.md
├── locales/
│   ├── de.json
│   └── en.json
├── data/
│   └── tickets.db              # SQLite database (auto-created)
└── src/
    ├── client.js
    ├── config.js
    ├── database.js
    ├── handlers/
    │   ├── commandHandler.js
    │   ├── eventHandler.js
    │   └── componentHandler.js
    ├── commands/
    │   ├── setup.js            # /setup
    │   ├── close.js            # /close
    │   ├── add.js              # /add
    │   ├── remove.js           # /remove
    │   ├── claim.js            # /claim
    │   ├── unclaim.js          # /unclaim
    │   ├── move.js             # /move
    │   ├── rename.js           # /rename
    │   ├── transcript.js       # /transcript
    │   ├── priority.js         # /priority
    │   ├── note.js             # /note
    │   ├── blacklist.js        # /blacklist
    │   ├── stats.js            # /stats
    │   ├── snippet.js          # /snippet  ← new
    │   ├── broadcast.js        # /broadcast  ← new
    │   └── lock.js             # /lock  ← new
    ├── events/
    │   ├── ready.js            # Bot start, status, auto-close & staff reminder loop
    │   ├── messageCreate.js    # Activity tracking + DM notifications
    │   └── interactionCreate.js
    ├── components/
    │   ├── buttons/
    │   │   ├── openTicket.js
    │   │   ├── closeTicket.js
    │   │   ├── claimTicket.js
    │   │   ├── unclaimTicket.js
    │   │   ├── moveTicket.js
    │   │   ├── deleteTicket.js
    │   │   ├── deleteConfirm.js
    │   │   ├── deleteCancel.js
    │   │   ├── rateTicket.js       # tb_rate:N
    │   │   └── notifyToggle.js     # tb_notifyToggle  ← new
    │   ├── modals/
    │   │   ├── closeReason.js
    │   │   └── ticketQuestions.js
    │   └── menus/
    │       ├── panelSelect.js
    │       ├── ticketType.js
    │       └── moveSelect.js
    └── utils/
        ├── logger.js
        ├── embeds.js
        ├── transcript.js       # Self-contained HTML (avatars embedded as Base64)
        ├── mskApi.js
        ├── ticketActions.js
        ├── versionCheck.js     # Startup update check against GitHub releases
        └── snippets.js         # Snippet loader & placeholder engine

🚀 Installation

Requirements

Node.js v18 or newer
A Discord bot token — discord.com/developers/applications

1. Install dependencies

cd discord_ticketbot
npm install

2. Set up environment variables

cp .env.example .env

Fill in .env:

# Required
TOKEN="your_bot_token"
CLIENT_ID="your_application_id"
GUILD_ID="your_server_id"

# Optional — MSK Transcript Service
MSK_API_KEY="your_msk_api_key"
MSK_API_URL="https://www.msk-scripts.de"

3. Set up the configuration

cp config/config.example.jsonc config/config.jsonc

4. (Optional) Set up canned responses

cp config/snippets.example.jsonc config/snippets.jsonc

Edit config/snippets.jsonc to define your team's canned responses. If the file does not exist, /snippet commands will show a setup hint.

5. Start the bot

npm start

6. Set up the panel

Run /setup on your Discord server (Administrator permission required).

🖥️ Autostart with systemd (Linux Server)

1. Copy bot files

sudo cp -r discord_ticketbot /opt/discord_ticketbot
sudo useradd -r -s /bin/false discord
sudo chown -R discord:discord /opt/discord_ticketbot

2. Set up `.env` on the server

sudo nano /opt/discord_ticketbot/.env

3. Verify the Node.js path

which node

Adjust ExecStart in ticketbot.service if the path differs from /usr/bin/node.

4. Install the systemd unit

sudo cp /opt/discord_ticketbot/ticketbot.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now ticketbot.service

5. Check the status

sudo systemctl status ticketbot.service
sudo journalctl -u ticketbot.service -f

Useful commands

Command	Description
`sudo systemctl start ticketbot.service`	Start the bot
`sudo systemctl stop ticketbot.service`	Stop the bot
`sudo systemctl restart ticketbot.service`	Restart the bot
`sudo systemctl enable ticketbot.service`	Enable autostart
`sudo systemctl disable ticketbot.service`	Disable autostart
`sudo journalctl -u ticketbot.service -f --output=cat`	Follow live logs with colors

⚙️ Slash Commands

Command	Permission	Description
`/setup`	Administrator	Send the ticket panel
`/close [reason]`	Configurable	Close the current ticket
`/claim`	Staff	Claim a ticket
`/unclaim`	Staff	Release a claimed ticket
`/move`	Staff	Move ticket to a different type/category
`/add <user>`	Staff	Add a user to the ticket
`/remove <user>`	Staff	Remove a user from the ticket
`/rename <name>`	Staff	Rename the ticket channel
`/transcript`	Staff	Generate an HTML transcript
`/priority <level>`	Staff	Set ticket priority
`/note add <text>`	Staff	Add a staff note
`/note list`	Staff	List all notes for this ticket
`/stats [user]`	Staff	Server-wide or per-user statistics
`/blacklist add/remove/list`	Manage Guild	Manage the user blacklist
`/snippet send <name>`	Staff	Send a canned response into the ticket
`/snippet list`	Staff	Show all available snippets
`/lock lock [reason]`	Staff	Lock ticket — user cannot send messages
`/lock unlock`	Staff	Unlock ticket — restore user message access
`/broadcast <message>`	Staff	Send a message to all open ticket channels

🔘 Ticket Buttons

Button	Visible when	Description
🔒 Close Ticket	Always (configurable)	Generates transcript, closes & renames channel
🙋 Claim	`claimButton: true`, unclaimed	Claim the ticket
🙌 Unclaim	`claimButton: true`, claimed	Release the ticket
🔀 Move	More than 1 type configured	Open type selection
🗑️ Delete Ticket	After closing	Delete channel after confirmation
🔕 Notify me	`userNotifications.enabled: true`	User opts in to DM notifications on staff reply

🛠️ Configuration Reference

Panel Interaction Type

"panel": {
  "interactionType": "BUTTON"    // "BUTTON" (default) or "SELECT_MENU"
}

Panel Logo & Banner

"panel": {
  "logo":   { "enabled": true, "file": "logo.png"   },
  "banner": { "enabled": true, "file": "banner.png" }
}

Bot Status

"status": {
  "enabled": true,
  "dynamic": false,              // true = live ticket count in status
  "dynamicText": "🎫 {open} open tickets", // placeholders: {open}, {total}, {closed}
  "dynamicInterval": 5,          // update interval in minutes
  "text": "Support Tickets",     // used when dynamic: false
  "type": "WATCHING",            // PLAYING, WATCHING, LISTENING, STREAMING, COMPETING
  "status": "online"
}

User Notifications

"userNotifications": {
  "enabled": true   // Show a 🔕 "Notify me" button in new tickets.
                    // User opts in → receives a DM when staff first replies.
                    // Rate-limited to 1 DM per 30 minutes per ticket.
}

Canned Responses (Snippets)

Snippets are defined in a separate file — not in config.jsonc:

cp config/snippets.example.jsonc config/snippets.jsonc

{
  "snippets": [
    {
      "name": "welcome",
      "description": "Welcome message at the start of a ticket",
      "content": "Hey {user}! 👋 Thanks for opening a ticket. We'll be with you shortly.",
      "embed": {
        "title": "👋 Welcome",
        "color": "#5865F2"
      }
    },
    {
      "name": "docs",
      "description": "Link to the MSK-Scripts documentation",
      "content": "Hey {user}, check out our docs: https://docu.msk-scripts.de",
      "embed": null
    }
  ]
}

Available placeholders: {user} · {staff} · {type} · {priority}

Commands: /snippet send <name> · /snippet list

Snippets support autocomplete — start typing the name or description to filter.

Staff Reminder

"staffReminder": { "enabled": true, "afterHours": 4, "pingRoles": true }

Rating System

"ratingSystem": { "enabled": true, "dmUser": true, "ratingsChannelId": "CHANNEL_ID" }

Startup Log Visibility

"showLog": true   // Show INFO log messages on startup (commands, events, components)
                  // Set to false for a cleaner output in production

Auto-Close

"autoClose": { "enabled": true, "inactiveHours": 48, "warnBeforeHours": 6, "excludeClaimed": true }

Channel State Overview

State	Channel Name	Channel Topic	Opening Embed
Ticket opened	`ticket-username`	`🟡 Medium`	Priority: 🟡 Medium
`/priority urgent`	`ticket-username`	`🔴 Urgent`	Priority: 🔴 Urgent
`/claim`	`ticket-username`	`🟡 Medium \| 🙋 Claimed by @Staff`	+ Claimed by field
`/lock lock`	`ticket-username`	unchanged	lock notice posted
Ticket closed	`closed-ticket-username`	unchanged	all buttons removed

🗄️ Database Schema

The SQLite database is created automatically at data/tickets.db. Columns are added automatically via migration if they are missing.

Table	Contents
`tickets`	All tickets: status, type, priority, claim, lock, notify, reminder, transcript
`blacklist`	Blocked users with reason and timestamp
`staff_notes`	Private staff notes per ticket
`ratings`	Ratings (1–5 ⭐) with optional comment

Columns added in recent updates:

Column	Default	Purpose
`locked`	`0`	Whether the ticket is currently locked
`notify_on_reply`	`0`	Whether the creator opted in to DM notifications
`last_notify_sent`	`NULL`	Timestamp of the last notification DM (30-min cooldown)

🌍 Adding a New Language

Copy locales/en.json, e.g. as locales/fr.json
Translate all strings
Set "lang": "fr" in config/config.jsonc

📖 Documentation

Full documentation: docu.msk-scripts.de

📝 License

AGPL-3.0 — Source code must remain open and be published under the same license when distributed or hosted.

Forks and modifications that remove or bypass the MSK Transcript Service integration are not permitted.

Name		Name	Last commit message	Last commit date
Latest commit History 79 Commits
.github		.github
assets		assets
config		config
docs		docs
locales		locales
src		src
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.md		LICENSE.md
README.md		README.md
README_GER.md		README_GER.md
SECURITY.md		SECURITY.md
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
ticketbot.service		ticketbot.service

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

🎫 Discord Ticket Bot

✨ Features

🔗 MSK Transcript Service

Subscription Tiers

Getting your API Key

Custom Domain (Premium & Premium+)

💖 Sponsors

📁 Project Structure

🚀 Installation

Requirements

1. Install dependencies

2. Set up environment variables

3. Set up the configuration

4. (Optional) Set up canned responses

5. Start the bot

6. Set up the panel

🖥️ Autostart with systemd (Linux Server)

1. Copy bot files

2. Set up .env on the server

3. Verify the Node.js path

4. Install the systemd unit

5. Check the status

Useful commands

⚙️ Slash Commands

🔘 Ticket Buttons

🛠️ Configuration Reference

Panel Interaction Type

Panel Logo & Banner

Bot Status

User Notifications

Canned Responses (Snippets)

Staff Reminder

Rating System

Startup Log Visibility

Auto-Close

Channel State Overview

🗄️ Database Schema

🌍 Adding a New Language

📖 Documentation

📝 License

About

Topics

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 6

Sponsor this project

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

2. Set up `.env` on the server