From 4147658575e1ad98e07a5ebab44e2a1fca8d7663 Mon Sep 17 00:00:00 2001 From: DJj123dj <80536295+DJj123dj@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:42:26 +0100 Subject: [PATCH] README Updates --- .eggs/README.md | 4 +- .github/CONTRIBUTING.md | 4 +- .github/SECURITY.md | 4 +- README.md | 114 +++++++++++++++++++++------------------- 4 files changed, 66 insertions(+), 60 deletions(-) diff --git a/.eggs/README.md b/.eggs/README.md index 576d737..11f0ae8 100644 --- a/.eggs/README.md +++ b/.eggs/README.md @@ -57,6 +57,6 @@ It's recommended to provide at least `1GB` of **Memory/RAM** and `5GB` of **disk Open Ticket Logo **Pterodactyl Eggs**
-[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)
+[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)
-© 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) \ No newline at end of file +© 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) \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5b8629a..c2241d5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -87,6 +87,6 @@ you are **REQUIRED to send the bug privately via one of the following methods:** Open Ticket Logo **Contributing Guidelines**
-[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)
+[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)
-© 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) \ No newline at end of file +© 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) \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md index e4ae1aa..36e9aaf 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -47,6 +47,6 @@ If possible, try to provide screenshots! Open Ticket Logo **Security Policy**
-[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)
+[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)
-© 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) \ No newline at end of file +© 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) \ No newline at end of file diff --git a/README.md b/README.md index c4f5e31..aaaf611 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -> ### 🎥 Content Creators 🎥 -> Hey there! We're searching for content creators that would want to create a tutorial or setup guide for Open Ticket!
+> ### 🎥 Content Creators +> Hey there! We're searching for content creators that would like to create a tutorial or setup guide for Open Ticket!
> [📌 More Information](.github/CONTENT_CREATORS.md) --- @@ -26,40 +26,42 @@ The bot is translated in more than 36 Languages and has been battle

⭐️ Help us grow by giving a star! ⭐️

### 📌 Features -- **🦇 pterodactyl support** - Open Ticket works perfect on Pterodactyl based panels! [(Download official eggs)](.eggs/README.md) -- **💩 no bloat** - Your Open Ticket bot doesn't contain any form of bloat or credits! -- **🔒 tested & secure** - Open Ticket has been battletested by thousands of servers and is very secure! -- **📈 scalable** - Open Ticket is made to handle huge servers! (Already tested in **servers with 100k members**) -- **📄 HTML transcripts** - Make use of the most customisable, beautiful and easy-to-use HTML Transcripts! -- **✅ ticket actions** - Close, Reopen, Delete, Claim, Pin, Rename & Move all your tickets! -- **🇬🇧 translation** - Open Ticket has been translated in more than **36 languages** by our community! -- **🎨 customisation** - Open Ticket has been created around customisation, everything can be customised! -- **🖥️ interactions** - The bot has full support for Buttons, Dropdowns, Slash Commands and Modals! -- **∞ unlimited** - Create an infinite amount of tickets & panels! -- **📝 advanced plugins** - Create advanced plugins or use pre-made ones by our community! -- **👥 user management** - Add & Remove users from all tickets! -- **📊 detailed stats** - Open Ticket has ticket, user & global staticstics available for everyone! -- **🚫 blacklist** - Blacklist users to prevent them from creating a ticket! -- **❓ questions** - Let users answer questions in a modal before the ticket is created! -- **📦 slash & text** - Open Ticket supports both slash & text commands! -- **📥 extra buttons** - The bot also supports Reaction Roles & Url Buttons, because why not ¯\\_(ツ)_/¯ -- **✨ commands** - The bot contains more than 25 commands! +- **⏳ 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 more using plugins! - - **💬 reviews** - Create & customise your own review system! - - **📢 feedback** - Collect feedback & create forms for people to answer! - - **🏷️ tags** - Create tags & answer questions automatically using keywords! - - **📝 forms** - Create advanced forms and ask people for additional details! - - **🔄 rotating status** - Create a rotating bot status & use dynamic variables from the bot! - - **💾 sqlite database** - Use an `sqlite` database for increased performances! - - **🎉 custom embeds** - Create your own embeds and use them in your server! - - **⏰ reminders** - Create & manage customisable reminders in your server! - - **🎨 customisation** - Yep, you heard it right! Even more customisation! +#### 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...** > ### 📦 Resources -> Not all resources are accurate yet! We are working on this.
-> Open Ticket Tutorial +> These resources will help with configuration and usage of the bot:
+> > Open Ticket Docs > Open Ticket Plugins @@ -83,19 +85,19 @@ A big thanks to all our sponsors! Without them, it wouldn't be possible to creat BENZORICH -### ⏱️ 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. -> 5. Start the bot using `npm start` or `node index.js` +> 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` > - 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. ### 💬 Translators -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: 🟢 Available - 🤖 Made Using AI - 🔴 Unavailable/Outdated** +With the amazing support of our translators, we've been able to translate Open Ticket in more than **36 languages**! +#### Categories: +- **🟢 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! @@ -184,13 +190,21 @@ This will help us grow and reach even more people! ## 🧩 Plugins -**Download all plugins in our [Official Plugin Repository](https://github.com/open-discord-bots/plugins)!**
+**Download all plugins from our [Official Plugin Repository](https://github.com/open-discord-bots/plugins)!**
> #### ⭐ 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. - --- Open Ticket Logo **README.md**
-[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)
+[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)
© 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)