258 lines
23 KiB
Markdown
258 lines
23 KiB
Markdown
<p align="center">
|
||
<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" width="650px"><br>
|
||
<span align="center"><b>The most advanced self-hosted ticket bot for Discord</b></span><br>
|
||
<sub align="center">Related Projects:</sub><br>
|
||
<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Discord" height="55px"><br><br>
|
||
<a href="https://discord.com/invite/26vT9wt3n3"><img alt="Discord Invite Link" src="https://img.shields.io/badge/discord-support%20server-5865F2.svg?style=flat-square&logo=discord"></img></a>
|
||
<a href="https://github.com/open-discord-bots/open-ticket/releases/tag/v4.1.3"><img alt="Open Ticket Version" src="https://img.shields.io/badge/version-4.1.3-brightgreen.svg?style=flat-square"></img></a>
|
||
<a href="https://otdocs.dj-dj.be"><img alt="Open Ticket Documentation" src="https://img.shields.io/badge/discord.js-v14-CB3837.svg?style=flat-square&logo=npm"></img></a>
|
||
<a href="https://github.com/open-discord-bots/open-ticket/blob/main/LICENSE"><img alt="Open Ticket License" src="https://img.shields.io/badge/license-GPL%203.0-important.svg?style=flat-square"></img></a>
|
||
<a href="https://otdocs.dj-dj.be"><img alt="Open Ticket Stars" src="https://img.shields.io/github/stars/djj123dj/open-ticket?color=yellow&label=stars&logo=github&style=flat-square"></img></a>
|
||
<br>
|
||
<a href="https://github.com/sponsors/DJj123dj"><img alt="Sponsor DJj123dj" src="https://img.shields.io/badge/sponsor-DJj123dj-ea4aaa?style=flat-square&logo=githubsponsors"></img></a>
|
||
<a href="https://hub.docker.com/repository/docker/djj123dj/open-ticket"><img alt="Open Ticket supports Docker!" src="https://img.shields.io/badge/docker-supported-2496ED?style=flat-square&logo=docker"></img></a>
|
||
<a href=".eggs/README.md"><img alt="Open Ticket supports Pterodactyl Eggs!" src="https://img.shields.io/badge/pterodactyl-supported-10539F?style=flat-square&logo=pterodactyl"></img></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
Open Ticket is the most advanced & customisable discord ticket bot available! You are able to customise up to 300+ settings and aspects! This includes <code>Html Transcripts</code>, <code>Advanced Plugins</code>, <code>Custom Embeds</code>, <code>Questions/Modals</code>, <code>Stats</code> & more!
|
||
The bot is translated in more than <code>36 Languages</code> and has been battle tested in large Discord servers! If you need any help, feel free to join our <a href="https://discord.dj-dj.be">discord server</a>!
|
||
</p>
|
||
|
||
<h3 align="center"><b>⭐️ Help us grow by giving a star! ⭐️</b></h3>
|
||
|
||
---
|
||
> **[-> Navigate to (⏱️ Quick Setup)](#️-quick-start-using-cli)**
|
||
> **[-> Navigate to (📚 Documentation)](https://otdocs.dj-dj.be)**
|
||
> **[-> Navigate to (📞 Support Server)](https://discord.dj-dj.be)**
|
||
|
||
### 📌 Features
|
||
- **⏳ Quick Setup** - Using the interactive Quick Setup CLI, you can **configure Open Ticket in less than 5min!**
|
||
- **🦇 Pterodactyl Support** - Open Ticket works perfect on Pterodactyl based panels. [(Download official eggs)](.eggs/README.md)
|
||
- **💩 No Credits** - Your bot won't contain any form of bloat or credits. It's all yours!
|
||
- **🔒 Private & Secure** - It has been battletested by thousands of servers and **respects security & privacy.**
|
||
- **📈 Scalable** - Made to handle huge servers and has already been **tested in servers with 100k members.**
|
||
- **📄 HTML Transcripts** - The **built-in HTML Transcripts Service** provides beautiful & easy-to-use transcripts.
|
||
- **✅ Ticket Status** - Close, reopen, delete, claim, pin, rename or move tickets in your server.
|
||
- **🇬🇧 Translation** - Every message has been translated in more than **36 languages** by our community.
|
||
- **🎨 Customisation** - More than **200+ settings** are related to customisation & advanced features.
|
||
- **🖥️ Interactions** - The bot has full support for buttons, dropdowns, slash/text commands & modals.
|
||
- **∞ Unlimited Possibilities** - Create an infinite amount of tickets, questions & panels.
|
||
- **📝 Advanced Plugins** - Create advanced plugins or use [**pre-made plugins**](#-plugins) by our community.
|
||
- **👥 Participants** - Add or remove participants & transfer ownership from one user to another.
|
||
- **📊 Detailed Statistics** - With more than **50+ statistics** for tickets, users & the server.
|
||
- **🚫 Blacklist** - Blacklist users to prevent them from creating new tickets.
|
||
- **🚨 Priorities** - Assign different **priority levels** to tickets to mark them as important.
|
||
- **❓ Modal Questions** - Give users the ability to **answer questions** in a modal before their ticket is created.
|
||
- **✨ Commands** - Manage all your tickets with more than 28+ commands.
|
||
- **🤖 Automation** - Automate ticket handling with **autoclose, autodelete** & slow mode.
|
||
- **😎 Additional Features** - For some weird reason, the bot also supports Reaction Role & URL Buttons.
|
||
|
||
#### And even more using [pre-made community plugins](#-plugins)!
|
||
- **💬 Reviews** - Create & manage a support review system.
|
||
- **📢 Feedback** - Collect feedback & create forms for users to answer.
|
||
- **⏰ Reminders** - Create & manage customisable reminders.
|
||
- **🏷️ Tags** - Create tags & answer questions automatically using keywords.
|
||
- **📝 Forms** - Create advanced forms and automatically ask for repetitive questions.
|
||
- **🔄 Channel Display** - Create a voice channel with realtime statistics from the ticket system.
|
||
- **💾 SQLite Database** - Use an `SQLite` database for increased performance.
|
||
- **🎉 Custom Embeds** - Create your own embeds and send them using a command.
|
||
- **🎨 Customisation** - Yep, you heard it right. Even more customisation!
|
||
- **😁 And so much more...**
|
||
|
||
### ⏱️ Quick Start (Using Interactive CLI Tool)
|
||
> 1. Download the latest version of Open Ticket on [Github](https://github.com/open-discord-bots/open-ticket).
|
||
> 2. Make sure Node.js & Npm are installed using `node -v` (minimum `v20`).
|
||
> 3. Install any required dependencies using `npm install`.
|
||
> 4. Start the **Quick Setup CLI** using `npm run setup`.
|
||
> 5. Click on `> ⏱️ Quick Setup` and follow the instructions.
|
||
> 6. Start the bot using `npm start` or `node index.js`
|
||
> - If required, the bot will give a report of errors that must be solved.
|
||
> - Follow the instructions and restart the bot.
|
||
> 7. Enjoy using Open Ticket!
|
||
>
|
||
> #### 🚦 Navigation
|
||
> **[-> Navigate to (📚 Documentation)](https://otdocs.dj-dj.be)**
|
||
> **[-> Navigate to (📞 Support Server)](https://discord.dj-dj.be)**
|
||
> **[-> Navigate to (🧩 Download Plugins)](https://odplugins.dj-dj.be)**
|
||
>
|
||
> #### 🖥️ Recommended Hosting
|
||
> - **A VPS (Virtual Private Server)** - Extra customisation & more stability. Recommended for most servers.
|
||
> - **Any Pterodactyl-Based Panel** - Easy installation & configuration.
|
||
|
||
### ❤️ Sponsors
|
||
Huge thanks to our sponsors for making this project possible. Your support means everything to us.
|
||
<table>
|
||
<tr>
|
||
<td><img src="https://github.com/guillee3.png" alt="Profile Picture" width="100px"></td>
|
||
<td><img src="https://github.com/yeeetSK.png" alt="Profile Picture" width="100px"></td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center"><a href="https://github.com/guillee3"><b>guillee3</b></a></td>
|
||
<td align="center"><a href="https://github.com/yeeetSK"><b>yeeetSK</b></a></td>
|
||
</tr>
|
||
</table>
|
||
|
||
**Past Sponsors:**<br>
|
||
<a href="https://github.com/sponsors/DJj123dj">
|
||
<img src="https://github.com/SpyEye2.png" alt="SpyEye" width="40px">
|
||
<img src="https://github.com/mods-hd.png" alt="Mods HD" width="40px">
|
||
<img src="https://github.com/DOSEV5.png" alt="DOSEV5" width="40px">
|
||
<img src="https://github.com/BENZORICH.png" alt="BENZORICH" width="40px">
|
||
</a>
|
||
|
||
## 📸 Preview
|
||
<img alt="An example of a panel." src="https://apis.dj-dj.be/cdn/openticket/preview-v4/panel-examples.png">
|
||
<img alt="An example of a ticket message." src="https://apis.dj-dj.be/cdn/openticket/preview-v4/ticket-example.png">
|
||
<img alt="Examples of built-in commands." src="https://apis.dj-dj.be/cdn/openticket/preview-v4/command-examples.png">
|
||
|
||
## 🛠️ Contributors
|
||
### 🖥️ Team & Contributors
|
||
A list of amazing people who have contributed or provided supported for **Open Ticket** and **Open Discord**.
|
||
<table>
|
||
<tr>
|
||
<td align="center"><img src="https://github.com/DJj123dj.png" alt="Profile Picture" width="80px"></td>
|
||
<td align="center"><img src="https://github.com/guillee3.png" alt="Profile Picture" width="80px"></td>
|
||
<td align="center"><img src="https://github.com/smetsliam.png" alt="Profile Picture" width="80px"></td>
|
||
<td align="center"><img src="https://github.com/FrankVissers.png" alt="Profile Picture" width="80px"></td>
|
||
<td align="center"><img src="https://github.com/Sank34.png" alt="Profile Picture" width="80px"></td>
|
||
<td align="center"><img src="https://github.com/SKaranjaN.png" alt="Profile Picture" width="80px"></td>
|
||
</tr>
|
||
<tr>
|
||
<th><a href="https://github.com/DJj123dj">💻🧩💬 DJj123dj</a></th>
|
||
<th><a href="https://github.com/guillee3">🧩💬 Guillee3</a></th>
|
||
<th><a href="https://github.com/smetsliam">💬 smetsliam</a></th>
|
||
<th><a href="https://github.com/FrankVissers">💬 Frank Vissers</a></th>
|
||
<th><a href="https://github.com/Sank34">💬 Sanke</a></th>
|
||
<th><a href="https://github.com/SKaranjaN">🧩 SKaranjaN</a></th>
|
||
</tr>
|
||
</table>
|
||
|
||
### 💬 Translators
|
||
With the amazing support of our translators, we've been able to translate Open Ticket in more than **36 languages**!
|
||
#### Categories:
|
||
- **🟢 Available**
|
||
- **🤖 Partially Made Using AI**
|
||
- **🟠 Incomplete**
|
||
- **🔴 Unavailable/Outdated**
|
||
|
||
|🔍 |Languages (36) |Maintainer (Github/Discord) |
|
||
|----|---------------------|--------------------------------|
|
||
|🟢 |🇬🇧 English |djj123dj |
|
||
|🟢 |🇳🇱 Dutch |djj123dj |
|
||
|🟢 |🇩🇪 German |benzorich |
|
||
|🟢 |🇫🇷 French |guillee.3 |
|
||
|🟢 |🇪🇸 Spanish |redactado & josuens |
|
||
|🟢 |🇵🇹 Portuguese |quiradon |
|
||
|🟢 |🇮🇹 Italian |fraden1mvp. & imperatorix_17 |
|
||
|🟢 |🇸🇪 Swedish |NoOneNook |
|
||
|🟢 |🇳🇴 Norwegian |NoOneNook |
|
||
|🟢 |🇹🇭 Thai |modshd |
|
||
|🟢 |🇮🇳 Hindi |challenger_nova |
|
||
|🟢 |🇭🇺 Hungarian |kornel0706 |
|
||
|🟢 |🇮🇩 Indonesian |erxg |
|
||
|🟢 |🇱🇹 Lithuanian |tsgindrius |
|
||
|🟢 |🇺🇦 Ukrainian |anderskiy |
|
||
|🟢 |🇨🇿 Czech |spyeye_ |
|
||
|🟢 |🇷🇴 Romanian |sankedev |
|
||
|🟢 |🇩🇰 Danish |the_gamer |
|
||
|🟢 |🇹🇷 Turkish |palestinian |
|
||
|🟢 |🇦🇪 Arabic |palestinian |
|
||
|🟢 |🇵🇱 Polish |danoglez |
|
||
|🟢 |🇮🇷 Persian |dysashop & zhavis |
|
||
|🟢 |🇧🇩 Bengali |HanumeshGupta |
|
||
|🟢 |❓ Catalan |guillee3 |
|
||
|🤖 |🇪🇪 Estonian |iamnotmega |
|
||
|🤖 |🇫🇮 Finnish |iamnotmega |
|
||
|🤖 |🇯🇵 Japanese |HanumeshGupta |
|
||
|🤖 |🇬🇷 Greek |HanumeshGupta |
|
||
|🤖 |🇸🇮 Slovenian |HanumeshGupta |
|
||
|🤖 |🇰🇷 Korean |HanumeshGupta |
|
||
|🤖 |🇮🇳 Tamil |HanumeshGupta |
|
||
|🤖 |🇨🇳 Simplified Chinese |HanumeshGupta |
|
||
|🤖 |❓ Kurdish |HanumeshGupta |
|
||
|🟠 |🇷🇺 Russian |NoOneNook |
|
||
|🟠 |🇱🇻 Latvian |NoOneNook |
|
||
|🟠 |🇻🇳 Vietnamese |ngocdiep2006 |
|
||
|🔴 |🇨🇳 Traditional Chinese|[⭐ Contribute!](.github/CONTRIBUTING.md)|
|
||
<!--[⭐ Contribute!](.github/CONTRIBUTING.md) -->
|
||
|
||
## ⭐️ Star History
|
||
If you enjoy using Open ticket, **consider starring** this repository.
|
||
This will help us grow and reach even more people!
|
||
|
||
<a href="https://star-history.com/#open-discord-bots/open-ticket&Date">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=open-discord-bots/open-ticket&type=Date&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=open-discord-bots/open-ticket&type=Date" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=open-discord-bots/open-ticket&type=Date" />
|
||
</picture>
|
||
</a>
|
||
|
||
## 🧩 Plugins
|
||
**Download all plugins from our [Official Plugin Repository](https://github.com/open-discord-bots/plugins)!**<br>
|
||
> #### ⭐ Featured Plugins (Top 5 Most Used)
|
||
> **[`ot-sqlite-database`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-sqlite-database/),
|
||
> [`ot-reviews`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-reviews/),
|
||
> [`ot-feedback`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-feedback/),
|
||
> [`ot-tags`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-tags/),
|
||
> [`ot-restrictions`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-restrictions/)**
|
||
|
||
#### Categories:
|
||
- **📄 Example** - These plugins serve as an example or starting template.
|
||
- **📢 Command** - These plugins add new commands to the bot.
|
||
- **⚙️ Utility** - These plugins help with utility systems. You might not notice them as a ticket user/admin directly.
|
||
- **🎨 Customisation** - These plugins add even more customisation to the bot.
|
||
- **💼 Management** - These plugins add features that help you manage your server or ticket system.
|
||
- **🤖 Client** - These plugins add features affecting the Discord Client or bot itself.
|
||
- Please Create a new category when your plugin doesn't fit in one of the available categories.
|
||
|
||
### 📦 Official *(made by DJdj Development)*
|
||
|Name |Category |Description |
|
||
|----------------------------------------------------------------------|----------------------------|-------------------------|
|
||
|[`example-plugin`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/example-plugin/) |📄 Example |This is just an example plugin for people that want to create their own plugin. |
|
||
|[`example-command`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/example-command/) |📄 Example |Sample custom command using the Open Discord system. |
|
||
|[`ot-jump-to-top`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-jump-to-top/) |📢 Command |Add a simple command to jump to the top of the ticket. |
|
||
|[`ot-kill-switch`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-kill-switch/) |📢 Command |Temporarily disable the ticket system using a kill switch. |
|
||
|[`ot-hosting-status`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-hosting-status/) |📢 Command |A simple command to send hosting status updates to a channel. |
|
||
|[`ot-shutdown`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-shutdown/) |📢 Command |A simple command to turn off the bot from a slash command (server & bot owner only). |
|
||
|[`ot-sqlite-database`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-sqlite-database/) |⚙️ Utility |With this plugin, the database will be an SQLite file. It's a must-have for large servers! |
|
||
|[`ot-no-slash-clear`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-no-slash-clear/) |⚙️ Utility |Disable the automatic removal of slash commands that aren't used by Open Ticket. |
|
||
|[`ot-migrate-v3`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-migrate-v3/) |⚙️ Utility |Use this plugin to migrate all tickets from Open Ticket v3 to v4. |
|
||
|[`ot-ticket-message-extras`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-ticket-message-extras/) |🎨 Customisation |A plugin which adds a few little features to the ticket message. |
|
||
|[`ot-rename-keep-prefix`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-rename-keep-prefix/) |🎨 Customisation |Simple plugin to keep the channel prefix when using the /rename command. |
|
||
|[`ot-customise-buttons`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-customise-buttons/) |🎨 Customisation |Customise almost all built-in buttons. This includes the claim, reopen, close & delete buttons. |
|
||
|[`ot-ephemeral-messages`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-ephemeral-messages/) |🎨 Customisation |Customise for every messages if it needs to be ephemeral or not. |
|
||
|[`ot-footers`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-footers/) |🎨 Customisation |A simple plugin to add footers in all Open Ticket embeds. |
|
||
|[`ot-alt-detector`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-alt-detector/) |💼 Management |Use the discord-alt-detector npm package by DJdj Development in your ticket bot. |
|
||
|[`ot-embeds`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-embeds/) |💼 Management |Create custom premade embeds in the config or use the command to create one from scratch. |
|
||
|[`ot-move-actions`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-move-actions/) |💼 Management |Automatically unclaim/unpin a ticket when it's moved using `/move`. |
|
||
|[`ot-reviews`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-reviews/) |💼 Management |Review system for Open Ticket! It is very customisable and has lots of features. |
|
||
|[`ot-tags`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-tags/) |💼 Management |Use tags to quickly reply with a pre-existing text. |
|
||
|[`ot-restrictions`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-restrictions/) |💼 Management |Restrict which roles can open a specific ticket option. |
|
||
|[`ot-better-status`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-better-status/) |🤖 Client |An advanced status plugin to rotate between states. It also allows for the use of variables. |
|
||
|[`ot-channel-display`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-channel-display/) |🤖 Client |A plugin to show different variables in a voice channel in your server. |
|
||
|[`ot-vanity`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-vanity/) |🤖 Client |A plugin to detect the vanity status of members in the server and give them exclusive privilleges. |
|
||
|
||
### ✅ Verified *(made by community)*
|
||
|Name |Author |Category |Description |
|
||
|---------------------------------------------------------------------|----------------------------|----------------------------|-------------------------|
|
||
|[`ot-config-reload`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-config-reload/) |guillee.3 |⚙️ Utility |This plugin adds a new command that allows reloading the Open Ticket config files without the need for a restart. |
|
||
|[`ot-ticket-forms`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-ticket-forms/) |guillee.3 |💼 Management |An advanced forms plugin for Open Ticket. |
|
||
|[`ot-feedback`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-feedback/) |an_developer |💼 Management |A plugin to gather feedback of your support service. |
|
||
|[`ot-assign-role`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-assign-role/) |rapid.fast |💼 Management |This plugin assigns a predefined role to a user upon creating a ticket. |
|
||
|[`ot-volume-warning`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-volume-warning/) |guillee.3 |💼 Management |Alerts ticket creators when too many tickets are open, indicating possible response delays. |
|
||
|[`ot-reminders`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-reminders/) |guillee.3 |💼 Management |Set reminders that will be sent to a channel every specified time. |
|
||
|[`ot-moderation`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-moderation/) |NotMukundOP |💼 Management |A simple moderation plugin for Open Discord with ban, kick & warnings. |
|
||
|[`ot-followups`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-followups/) |guillee.3 |💼 Management |Send additional follow-up messages to a ticket. |
|
||
|[`ot-twitch-notifier`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-twitch-notifier/) |guillee.3 |💼 Management |Get notified when your favorite Twitch streamers go live. |
|
||
|[`ot-translate-cmds`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-translate-cmds/) |guillee.3 |🤖 Client |Translate all built-in command names, descriptions & options. |
|
||
|
||
---
|
||
<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="170px">
|
||
|
||
**README.md**<br>
|
||
[Changelog](https://otgithub.dj-dj.be/releases) - [Documentation](https://otdocs.dj-dj.be) - [Website](https://openticket.dj-dj.be) - [Support Server](https://discord.dj-dj.be) - [License](./LICENSE.md)<br>
|
||
|
||
© 2021 - 2026 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms) - [Privacy Policy](https://www.dj-dj.be/privacy) - [Support Us](https://github.com/sponsors/DJj123dj)
|