DiscordTickets/README.md

110 lines
6.7 KiB
Markdown
Raw Normal View History

2021-03-03 12:57:28 +02:00
[![GitHub stars](https://img.shields.io/github/stars/discord-tickets/bot?style=flat-square)](https://github.com/discord-tickets/bot/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/discord-tickets/bot?style=flat-square)](https://github.com/discord-tickets/bot/stargazers)
2021-05-29 20:03:26 +03:00
[![License](https://img.shields.io/github/license/discord-tickets/bot?style=flat-square)](https://github.com/discord-tickets/bot/blob/main/LICENSE)
feat: #206 convert to interactions (buttons and application commands) (#238) * feat: make command handler slash command-ready Only `help` and `settings` commands work so far * feat(commands): finish new settings command * fix(settings): convert `roles` and `ping` to an array * fix(commands): make `add` a slash command * fix(commands): make `blacklist` a slash command * fix(commands): remove URLs from `help` command * Add weblate badge and overview image * Update sponsors * sqlite things * imrpovements * update eslint rules * (⚠ untested) close command * fix: default locale for getting command option names * Update README.md * Update README.md * Update README.md * update new command to slash commands and fix close command * fixes and improvements * fix: closing a ticket when the creator has left * Revert "fix: closing a ticket when the creator has left" This reverts commit afc40ae17077782e344fd8cee03a089966c2347e. * fix: closing a ticket when the creator has left * fix: localisation issues in settings command * fix: delete category channel * New button and select panels + updated message panels Includes new options for panel embed message image and thumbnail Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * Finish converting to buttons, added close button Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * fully convert to slash commands * re-add "... has created a ticket" message * locales * fix add and remove commands * fix remove command * fix stats command * eslint Co-authored-by: Puneet Gopinath <baalkrshna@gmail.com> Co-authored-by: thevisuales <6569806+thevisuales@users.noreply.github.com>
2021-09-24 17:32:36 +03:00
![](https://img.shields.io/badge/dynamic/json?color=5865F2&label=bots&query=clients&url=https%3A%2F%2Fstats.discordtickets.app&logo=discord&logoColor=white&style=flat-square)
![](https://img.shields.io/badge/dynamic/json?color=5865F2&label=tickets&query=tickets&url=https%3A%2F%2Fstats.discordtickets.app&logo=discord&logoColor=white&style=flat-square)
2021-05-22 02:04:18 +03:00
[![Codacy](https://img.shields.io/codacy/grade/b974eb5f984c40868e07d82c968bd02d?logo=codacy&style=flat-square)](https://www.codacy.com/gh/discord-tickets/bot/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=discord-tickets/bot&amp;utm_campaign=Badge_Grade)
[![Discord](https://img.shields.io/discord/451745464480432129?label=discord&color=7289DA&style=flat-square)](https://go.eartharoid.me/discord)
2021-09-24 21:45:12 +03:00
[![Weblate](http://i18n.capestar.net/widgets/discord-tickets/-/bot/svg-badge.svg)](https://i18n.capestar.net/engage/discord-tickets/)
2021-02-23 01:39:38 +02:00
2021-05-22 02:04:18 +03:00
<br>
2021-02-23 01:39:38 +02:00
2021-08-13 23:42:10 +03:00
![Discord Tickets](https://img.eartharoid.me/insecure/plain/https://static.eartharoid.me/discord-tickets/logo/wordmark/gradient.png@png)
2021-02-23 01:55:34 +02:00
2021-05-22 02:04:18 +03:00
An open-source ticket management bot for Discord - a free alternative to the premium and white-label plans of other popular ticketing bots.
2021-02-23 01:39:38 +02:00
## What is this?
2021-05-30 22:39:14 +03:00
Discord Tickets is a Discord bot for creating and managing ticket channels. It is a free and open-source alternative to the paid "premium" and "white-label" plans of popular ticketing bots, such as [Ticket Tool](https://tickettool.xyz/), [TicketsBot](https://ticketsbot.net/), [Tickety](https://tickety.net/), [Helper.gg](https://helper.gg/), [Helper](https://helper.wtf), and others.
2021-02-23 01:39:38 +02:00
2021-05-30 22:39:14 +03:00
Discord Tickets is feature-rich and much more customisable than many of the bots mentioned above. As it is intended for self-hosting, the bot can have your community/company's logo, for free.
2021-02-23 01:39:38 +02:00
2021-02-25 11:58:19 +02:00
Although intended for use in a single Discord server, the bot can also function in multiple servers at once if you run more than one community.
2021-02-23 01:39:38 +02:00
### Features
2021-03-15 23:12:58 +02:00
Discord Tickets is packed full of features, many of which were suggested by its users. If it's missing a feature you want, you can:
2021-02-23 01:39:38 +02:00
- Create a plugin for it, if you can code JavaScript
- Request someone else to make a plugin
2021-05-30 22:39:14 +03:00
- [Submit a feature request](https://github.com/discord-tickets/.github/blob/main//CONTRIBUTING.md#submitting-a-feature-request) if you think many other users would benefit from it
2021-02-23 01:39:38 +02:00
2021-03-15 23:12:58 +02:00
Here's some of the things that makes Discord Tickets awesome:
2021-02-23 01:46:15 +02:00
2021-02-24 14:18:34 +02:00
1. **Highly customisable**
2021-02-23 01:39:38 +02:00
Some messages can be configured for each server and for each ticket category. Every other message is set in the locale files, making it relatively easy to override the default messages.
You can also configure the functionality of the bot to your liking and add commands with plugins.
2021-02-24 14:18:34 +02:00
2. **Localisable**
2021-05-30 22:39:14 +03:00
If the bot hasn't already been translated to your (community's) language, you can [translate](https://github.com/discord-tickets/.github/blob/main//CONTRIBUTING.md#translating) it yourself.
2021-02-23 01:39:38 +02:00
Plugin authors are encouraged to support multiple languages as well.
2021-09-24 22:18:36 +03:00
[![Weblate](https://i18n.capestar.net/widgets/discord-tickets/-/bot/multi-auto.svg)](https://i18n.capestar.net/engage/discord-tickets/)
feat: #206 convert to interactions (buttons and application commands) (#238) * feat: make command handler slash command-ready Only `help` and `settings` commands work so far * feat(commands): finish new settings command * fix(settings): convert `roles` and `ping` to an array * fix(commands): make `add` a slash command * fix(commands): make `blacklist` a slash command * fix(commands): remove URLs from `help` command * Add weblate badge and overview image * Update sponsors * sqlite things * imrpovements * update eslint rules * (⚠ untested) close command * fix: default locale for getting command option names * Update README.md * Update README.md * Update README.md * update new command to slash commands and fix close command * fixes and improvements * fix: closing a ticket when the creator has left * Revert "fix: closing a ticket when the creator has left" This reverts commit afc40ae17077782e344fd8cee03a089966c2347e. * fix: closing a ticket when the creator has left * fix: localisation issues in settings command * fix: delete category channel * New button and select panels + updated message panels Includes new options for panel embed message image and thumbnail Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * Finish converting to buttons, added close button Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * fully convert to slash commands * re-add "... has created a ticket" message * locales * fix add and remove commands * fix remove command * fix stats command * eslint Co-authored-by: Puneet Gopinath <baalkrshna@gmail.com> Co-authored-by: thevisuales <6569806+thevisuales@users.noreply.github.com>
2021-09-24 17:32:36 +03:00
2021-02-24 14:18:34 +02:00
3. **Multiple ticket categories**
2021-02-23 01:39:38 +02:00
Each ticket category has its own settings for messages and the support team roles. There's also multiple methods of creating a ticket.
2021-02-24 14:18:34 +02:00
4. **A beautiful ticket archives portal**
2021-05-30 22:39:14 +03:00
**\[COMING SOON\] :** Add the official [Discord Tickets Portal](https://github.com/discord-tickets/portal) plugin for an instant ticket archives website.
2021-02-23 01:39:38 +02:00
2021-05-30 22:39:14 +03:00
1. **Open-source and self-hosted**
It's yours, you have full control.
2021-02-23 01:39:38 +02:00
## Getting started
2021-02-26 18:07:20 +02:00
| [**Host it yourself**](https://discordtickets.app/installation) | [**Fully managed hosting**](https://discordtickets.app/hosting) | [**Public test bot**](https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=475371285531066368) |
2021-02-23 01:39:38 +02:00
|:-:|:-:|:-:|
2021-02-23 22:52:19 +02:00
| Recommended if you have a host and you've done this before. | Recommended if you have no idea what you're doing. | Try out the bot. Not recommended for production use. |
2021-02-26 18:07:20 +02:00
| [Go to the docs »](https://discordtickets.app/installation) | [Learn more »](https://discordtickets.app/hosting) | [Add to Discord »](https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=475371285531066368) |
2021-02-23 01:39:38 +02:00
## Documentation
2021-02-26 18:07:20 +02:00
You will find most of information you need at [discordtickets.app](https://discordtickets.app).
2021-02-23 01:39:38 +02:00
## Support
2021-03-03 12:57:28 +02:00
If the [documentation](https://discordtickets.app) leaves you with questions, you can ask for help in the [discussions](https://github.com/discord-tickets/bot/discussions/categories/support-q-a) or join the support server on Discord.
2021-02-23 01:39:38 +02:00
2021-08-13 23:42:10 +03:00
[![Join the Discord server](https://img.eartharoid.me/insecure/rs:auto:440:200/plain/s3://eartharoid/images/join-discord.png@png)](https://go.eartharoid.me/discord)
2021-02-23 01:39:38 +02:00
## Contributing
2021-05-30 22:39:14 +03:00
For contributing instructions, or to find out all of the ways you can contribute, read [CONTRIBUTING.md](https://github.com/discord-tickets/.github/blob/main//CONTRIBUTING.md). All contributions are welcome and encouraged, but please [read the information](https://github.com/discord-tickets/.github/blob/main//CONTRIBUTING.md) given before doing so.
2021-02-23 01:39:38 +02:00
## Contributors
2021-03-15 23:12:58 +02:00
Thank you to everyone to has contributed to Discord Tickets, including everyone who has:
2021-02-23 01:39:38 +02:00
- Contributed code
- Translated
- Improved documentation
- Reported bugs
- Requested a feature
2021-02-25 11:58:19 +02:00
- Given help or support to other users
- Created a public plugin
- Created resources such as tutorials
2021-02-23 01:39:38 +02:00
2021-05-29 20:03:26 +03:00
**A full list of contributors can be found in [CONTRIBUTORS.md](https://github.com/discord-tickets/bot/blob/main/CONTRIBUTORS.md).**
2021-02-23 01:39:38 +02:00
## Sponsors
feat: #206 convert to interactions (buttons and application commands) (#238) * feat: make command handler slash command-ready Only `help` and `settings` commands work so far * feat(commands): finish new settings command * fix(settings): convert `roles` and `ping` to an array * fix(commands): make `add` a slash command * fix(commands): make `blacklist` a slash command * fix(commands): remove URLs from `help` command * Add weblate badge and overview image * Update sponsors * sqlite things * imrpovements * update eslint rules * (⚠ untested) close command * fix: default locale for getting command option names * Update README.md * Update README.md * Update README.md * update new command to slash commands and fix close command * fixes and improvements * fix: closing a ticket when the creator has left * Revert "fix: closing a ticket when the creator has left" This reverts commit afc40ae17077782e344fd8cee03a089966c2347e. * fix: closing a ticket when the creator has left * fix: localisation issues in settings command * fix: delete category channel * New button and select panels + updated message panels Includes new options for panel embed message image and thumbnail Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * Finish converting to buttons, added close button Co-Authored-By: Puneet Gopinath <baalkrshna@gmail.com> Co-Authored-By: thevisuales <6569806+thevisuales@users.noreply.github.com> * fully convert to slash commands * re-add "... has created a ticket" message * locales * fix add and remove commands * fix remove command * fix stats command * eslint Co-authored-by: Puneet Gopinath <baalkrshna@gmail.com> Co-authored-by: thevisuales <6569806+thevisuales@users.noreply.github.com>
2021-09-24 17:32:36 +03:00
*Does your community or company use Discord Tickets? [Sponsor the project](https://github.com/discord-tickets/bot/?sponsor=1) to get your logo shown here.*
**These awesome people and communities sponsor Discord Tickets:**
- [reSkybounds](https://reskybounds.com/) ([Discord](https://discord.reskybounds.com/))
- [Cal#0004](https://discord.com/users/239036926152146944) <!-- @24c4 -->
2021-02-23 01:39:38 +02:00
### Donate
[![Donate at ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/eartharoid)
## License
2021-05-29 20:03:26 +03:00
Discord Tickets is licensed under the [GPLv3 license](https://github.com/discord-tickets/bot/blob/main/LICENSE).
2021-02-23 01:39:38 +02:00
2021-05-22 02:04:18 +03:00
This is not an official Discord product. It is not affiliated with nor endorsed by Discord Inc.
2021-02-23 01:39:38 +02:00
© 2021 Isaac Saunders