README Updates

2025-11-05 14:42:26 +01:00
parent f7cda48ed6
commit 4147658575
4 changed files with 66 additions and 60 deletions
@@ -57,6 +57,6 @@ It's recommended to provide at least `1GB` of **Memory/RAM** and `5GB` of **disk
 <img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="170px">
 **Pterodactyl Eggs**<br>
-[changelog](https://otgithub.dj-dj.be/releases) - [documentation](https://otdocs.dj-dj.be) - [tutorial](https://www.youtube.com/watch?v=2jK9kAf6ASU) - [website](https://openticket.dj-dj.be) - [discord](https://discord.dj-dj.be)<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>
-© 2025 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms#terms) - [Privacy Policy](https://www.dj-dj.be/terms#privacy)
+© 2025 - [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)
@@ -87,6 +87,6 @@ you are **REQUIRED to send the bug privately via one of the following methods:**
 <img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="170px">
 **Contributing Guidelines**<br>
-[changelog](https://otgithub.dj-dj.be/releases) - [documentation](https://otdocs.dj-dj.be) - [tutorial](https://www.youtube.com/watch?v=2jK9kAf6ASU) - [website](https://openticket.dj-dj.be) - [discord](https://discord.dj-dj.be)<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>
-© 2025 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms#terms) - [Privacy Policy](https://www.dj-dj.be/terms#privacy)
+© 2025 - [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)
@@ -47,6 +47,6 @@ If possible, try to provide screenshots!
 <img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" width="170px">
 **Security Policy**<br>
-[changelog](https://otgithub.dj-dj.be/releases) - [documentation](https://otdocs.dj-dj.be) - [tutorial](https://www.youtube.com/watch?v=2jK9kAf6ASU) - [website](https://openticket.dj-dj.be) - [discord](https://discord.dj-dj.be)<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>
-© 2025 - [DJdj Development](https://www.dj-dj.be) - [Terms](https://www.dj-dj.be/terms#terms) - [Privacy Policy](https://www.dj-dj.be/terms#privacy)
+© 2025 - [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)
@@ -1,5 +1,5 @@
-> ### 🎥 Content Creators 🎥
+> ### 🎥 Content Creators
-> Hey there! We're searching for content creators that would want to create a tutorial or setup guide for Open Ticket!<br>
+> Hey there! We're searching for content creators that would like to create a tutorial or setup guide for Open Ticket!<br>
 > [📌 More Information](.github/CONTENT_CREATORS.md)
 ---
@@ -26,40 +26,42 @@ The bot is translated in more than <code>36 Languages</code> and has been battle
 <h3 align="center"><b>⭐️ Help us grow by giving a star! ⭐️</b></h3>
 ### 📌 Features
- **🦇 pterodactyl support** - Open Ticket works perfect on Pterodactyl based panels! [(Download official eggs)](.eggs/README.md)
+- **⏳ Quick Setup** - Using the interactive Quick Setup CLI, you can **configure Open Ticket in less than 5min!**
- **💩 no bloat** - Your Open Ticket bot doesn't contain any form of bloat or credits!
+- **🦇 Pterodactyl Support** - Open Ticket works perfect on Pterodactyl based panels. [(Download official eggs)](.eggs/README.md)
- **🔒 tested & secure** - Open Ticket has been battletested by thousands of servers and is very secure!
+- **💩 No Credits** - Your bot won't contain any form of bloat or credits. It's all yours!
- **📈 scalable** - Open Ticket is made to handle huge servers! (Already tested in **servers with 100k members**)
+- **🔒 Private & Secure** - It has been battletested by thousands of servers and **respects security & privacy.**
- **📄 HTML transcripts** - Make use of the most customisable, beautiful and easy-to-use HTML Transcripts!
+- **📈 Scalable** - Made to handle huge servers and has already been **tested in servers with 100k members.**
- **✅ ticket actions** - Close, Reopen, Delete, Claim, Pin, Rename & Move all your tickets!
+- **📄 HTML Transcripts** - The **built-in HTML Transcripts Service** provides beautiful & easy-to-use transcripts.
- **🇬🇧 translation** - Open Ticket has been translated in more than **36 languages** by our community!
+- **✅ Ticket Status** - Close, reopen, delete, claim, pin, rename or move tickets in your server.
- **🎨 customisation** - Open Ticket has been created around customisation, everything can be customised!
+- **🇬🇧 Translation** - Every message has been translated in more than **36 languages** by our community.
- **🖥️ interactions** - The bot has full support for Buttons, Dropdowns, Slash Commands and Modals!
+- **🎨 Customisation** - More than **200+ settings** are related to customisation & advanced features.
- **∞ unlimited** - Create an infinite amount of tickets & panels!
+- **🖥️ Interactions** - The bot has full support for buttons, dropdowns, slash/text commands & modals.
- **📝 advanced plugins** - Create advanced plugins or use pre-made ones by our community!
+- **∞ Unlimited Possibilities** - Create an infinite amount of tickets, questions & panels.
- **👥 user management** - Add & Remove users from all tickets!
+- **📝 Advanced Plugins** - Create advanced plugins or use [**pre-made plugins**](#-plugins) by our community.
- **📊 detailed stats** - Open Ticket has ticket, user & global staticstics available for everyone!
+- **👥 Participants** - Add or remove participants & transfer ownership from one user to another.
- **🚫 blacklist** - Blacklist users to prevent them from creating a ticket!
+- **📊 Detailed Statistics** - With more than **50+ statistics** for tickets, users & the server.
- **❓ questions** - Let users answer questions in a modal before the ticket is created!
+- **🚫 Blacklist** - Blacklist users to prevent them from creating new tickets.
- **📦 slash & text** - Open Ticket supports both slash & text commands!
+- **🚨 Priorities** - Assign different **priority levels** to tickets to mark them as important.
- **📥 extra buttons** - The bot also supports Reaction Roles & Url Buttons, because why not ¯\\_(ツ)_/¯
+- **❓ Modal Questions** - Give users the ability to **answer questions** in a modal before their ticket is created.
- **✨ commands** - The bot contains more than 25 commands!
+- **✨ 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 more using plugins!
+#### And even more using [pre-made community plugins](#-plugins)!
-  - **💬 reviews** - Create & customise your own review system!
+  - **💬 Reviews** - Create & manage a support review system.
-  - **📢 feedback** - Collect feedback & create forms for people to answer!
+  - **📢 Feedback** - Collect feedback & create forms for users to answer.
-  - **🏷️ tags** - Create tags & answer questions automatically using keywords!
+  - **⏰ Reminders** - Create & manage customisable reminders.
-  - **📝 forms** - Create advanced forms and ask people for additional details!
+  - **🏷️ Tags** - Create tags & answer questions automatically using keywords.
-  - **🔄 rotating status** - Create a rotating bot status & use dynamic variables from the bot!
+  - **📝 Forms** - Create advanced forms and automatically ask for repetitive questions.
-  - **💾 sqlite database** - Use an `sqlite` database for increased performances!
+  - **🔄 Channel Display** - Create a voice channel with realtime statistics from the ticket system.
-  - **🎉 custom embeds** - Create your own embeds and use them in your server!
+  - **💾 SQLite Database** - Use an `SQLite` database for increased performance.
-  - **⏰ reminders** - Create & manage customisable reminders in your server!
+  - **🎉 Custom Embeds** - Create your own embeds and send them using a command.
-  - **🎨 customisation** - Yep, you heard it right! Even more customisation!
+  - **🎨 Customisation** - Yep, you heard it right. Even more customisation!
  - **😁 And so much more...**
 > ### 📦 Resources
-> Not all resources are accurate yet! We are working on this.<br>
+> These resources will help with configuration and usage of the bot:<br>
-> <a href="https://openticket.dj-dj.be/message.html?msg=The%20current%20tutorial%20is%20outdated,%20we%27re%20still%20working%20on%20a%20new%20one!"><img src="https://apis.dj-dj.be/cdn/openticket/open-ticket-tutorial.png" alt="Open Ticket Tutorial" width="180px"></a>
+> <!--<a href="https://openticket.dj-dj.be/message.html?msg=The%20current%20tutorial%20is%20outdated,%20we%27re%20still%20working%20on%20a%20new%20one!"><img src="https://apis.dj-dj.be/cdn/openticket/open-ticket-tutorial.png" alt="Open Ticket Tutorial" width="180px"></a>-->
 > <a href="https://otdocs.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/open-ticket-docs.png" alt="Open Ticket Docs" width="180px"></a>
 > <a href="https://github.com/open-discord-bots/plugins"><img src="https://apis.dj-dj.be/cdn/openticket/open-ticket-plugins.png" alt="Open Ticket Plugins" width="180px"></a>
@@ -83,19 +85,19 @@ A big thanks to all our sponsors! Without them, it wouldn't be possible to creat
 <img src="https://github.com/BENZORICH.png" alt="BENZORICH" width="40px">
 </a>
-### ⏱️ Quick Setup
+### ⏱️ Quick Setup (Using CLI)
 > 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 `v18`).
+> 2. Make sure node.js & npm are installed using `node -v` (minimum `v20`).
 > 3. Install any required dependencies using `npm install`.
-> 4. Configure the bot in the `./config/` directory.
+> 4. Start the **Quick Setup CLI** using `npm run setup`.
-> 5. Start the bot using `npm start` or `node index.js`
+> 5. Click on `> ⏱️ Quick Setup` and follow the instructions.
 > 6. Start the bot using `npm start` or `node index.js`
 >    - The bot will let you know any existing config errors.
 >    - Fix these errors and restart the bot.
-> 6. Enjoy using Open Ticket!
+> 7. Enjoy using Open Ticket!
 > ### [📔 Visit Documentation](https://otdocs.dj-dj.be)
 >
 > ### 🖥️ Recommended Hostings
 > - [⭐ **Peakhosting.nl**](https://peakhosting.nl/) - Official support for Open Ticket pterodactyl eggs.
 > - **Any Pterodactyl-Based Panel** - Easy installation & configuration.
 > - **A Virtual Private Server (VPS)** - Extra customisation & more stability. Recommended for large servers.
 > 
@@ -127,9 +129,13 @@ A list of people that contributed or provided the most support for Open Ticket.
 </table>
 ### 💬 Translators
-With the amazing support of our translators, we've been able to translate Open Ticket in more than **36 languages**!  
+With the amazing support of our translators, we've been able to translate Open Ticket in more than **36 languages**!
-As a result, you're able to enjoy using Open Ticket in your own native language.
+#### Categories:
- **Categories: 🟢 Available - 🤖 Made Using AI - 🔴 Unavailable/Outdated**
+- **🟢 Available**
 - **⏳ In Progress (Incomplete)**
 - **🤖 Made Using AI**
 - **🟠 Incomplete**
 - **🔴 Unavailable/Outdated**
 |🔍 |Languages (36)        |Maintainer (Github/Discord)    |
 |---|---------------------|--------------------------------|
@@ -172,7 +178,7 @@ As a result, you're able to enjoy using Open Ticket in your own native language.
 |🔴 |🇨🇳 Traditional Chinese|[⭐ Contribute!](.github/CONTRIBUTING.md)|
 ## ⭐️ Star History
-Please give this repository a star if you like it.  
+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">
@@ -184,13 +190,21 @@ This will help us grow and reach even more people!
 </a>
 ## 🧩 Plugins
-**Download all plugins in our [Official Plugin Repository](https://github.com/open-discord-bots/plugins)!**<br>
+**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-migrate-v3`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-migrate-v3/),
 > [`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-tags`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-tags/),
 > [`ot-config-reload`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/ot-config-reload/)**
 #### 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.
 ### 📦 Official *(made by DJdj Development)*
 |Name                                                                  |Category                    |Description              |
@@ -227,18 +241,10 @@ This will help us grow and reach even more people!
 |[`od-reminders`](https://github.com/open-discord-bots/plugins/tree/main/open-ticket/od-reminders/)                        |guillee.3                   |💼 Management               |Set reminders that will be sent to a channel every specified time. |
 |[`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. |
 ### 📢 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 backend & systems. You won't notice it in discord itself.
 - **🎨 Customisation** - These plugins help you customise the bot even further.
 - **💼 Management** - These plugins add features that help you manage your server.
 - **🤖 Client** - These plugins add features affecting the discord client or bot itself.
 ---
 <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) - [tutorial](https://www.youtube.com/watch?v=2jK9kAf6ASU) - [website](https://openticket.dj-dj.be) - [discord server](https://discord.dj-dj.be) - [license](./LICENSE.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>
 © 2025 - [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)