mirror of https://github.com/Hessenuk/DiscordTickets.git synced 2024-11-09 14:23:08 +02:00

The most popular open-source and self-hosted ticket management bot for Discord - a free alternative to the premium and white-label plans of other popular ticketing bots.

Go to file

Isaac 44023f6e4b move		2021-02-23 23:55:23 +00:00
.github	Contributor stuff	2021-02-22 16:18:06 +00:00
docs	move	2021-02-23 23:55:23 +00:00
overrides	Start making	2021-02-16 00:02:44 +00:00
src	things	2021-02-22 23:40:16 +00:00
user	do stuff	2021-02-22 00:05:37 +00:00
.all-contributorsrc	docs	2021-02-23 20:52:19 +00:00
.eslintrc.js	Set up for v3	2021-02-15 18:34:59 +00:00
.gitattributes	Initial commit	2019-05-03 22:03:32 +01:00
.gitignore	Contributor stuff	2021-02-22 16:18:06 +00:00
.replit	Add run on repl.it badge to README	2020-07-31 12:48:55 +00:00
CONTRIBUTORS.md	Contributor stuff	2021-02-22 16:18:06 +00:00
example.env	things	2021-02-16 22:34:20 +00:00
LICENSE	Initial commit	2019-05-03 22:03:32 +01:00
mkdocs.yml	Plugin improvements and JSDoc	2021-02-17 20:17:35 +00:00
package.json	progress	2021-02-20 17:09:08 +00:00
pnpm-lock.yaml	Clean up	2021-02-17 13:24:33 +00:00
README.md	docs	2021-02-23 20:52:19 +00:00
requirements.txt	Set up for v3	2021-02-15 18:34:59 +00:00

README.md

⚠️ The code on the master branch is for v3 which is not ready. Please go to the v2 branch for the current version of the code and documentation

The following information is about v3. Please read the README file on the v2 branch for information that is about the current version.

DiscordTickets

An open-source ticket management bot for Discord - a free alternative to the premium and white-label plans of other popular ticketing bots.

What is this?
- Features
- Screenshots
Getting started
Documentation
Support
Contributing
Contributors
Sponsors
- Donate
License

What is this?

DiscordTickets is a Discord bot for creating and managing "support ticket" channels. It is a free and open-source alternative to the popular paid "premium" and "white-label" ticketing bots, such as Ticket Tool, TicketsBot, Tickety, Helper.gg, Helper, and others.

DiscordTickets 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 or company's logo, for free.

Although intended for use in a single Discord server, the bot can also function in multiple servers at once if run more than one community.

Features

DiscordTickets is packed full of features, many of which were suggested by its users. If it's missing a feature you want, you can:

Create a plugin for it, if you can code JavaScript
Request someone else to make a plugin
Submit a feature request if you think many other users would benefit from it

Here's some of the things that makes DiscordTickets awesome:

1. Highly customisable

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.

2. Localisable

If the bot hasn't already been translated to your (community's) language, you can translate it yourself.

Plugin authors are encouraged to support multiple languages as well.

3. Multiple ticket categories

Each ticket category has its own settings for messages and the support team roles. There's also multiple methods of creating a ticket.

4. A beautiful ticket archives portal

Add the official DiscordTickets-Portal plugin for an instant ticket archives website.

5. Plugin support

Developers can add a lot of functionality to DiscordTickets without modifying the source code by creating plugins. Plugins can listen for client and ticket events, create commands, and more. DiscordTickets-Portal is an example of what can be done with plugins.

6. Open-source and self-hosted

It's yours.

7. Supports multiple databases

DiscordTickets uses Sequelize to allow you to choose from SQLite, MySQL, MariaDB, PostreSQL, or MSSQL for your database, with very little setup.

If you choose SQLite, which is the default as it is the easiest, you don't need to do anything! If you choose to use another database (recommended), you only need to install the package(s) with NPM and create the database. All of the database tables are created automatically, regardless of which database type you use.

Screenshots

screenshot of a ticket channel

screenshot of a panel

Getting started

Host it yourself	Fully managed hosting	Public test bot
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.
Go to the docs »	Learn more »	Add to Discord »

Documentation

You will find most of information you need at discordtickets.eartharoid.me.

Support

If the documentation leaves you with questions, you can ask for help in the discussions or join the support server on Discord.

Contributing

For contributing instructions, or to find out all of the ways you can contribute, read CONTRIBUTING.md. All contributions are welcome and encouraged, but please read the information given before doing so.

Contributors

Thank you to everyone to has contributed to DiscordTickets, including everyone who has:

Contributed code
Translated
Improved documentation
Supported and helped others
Created resources such as tutorials
Created a public plugin
Reported bugs
Requested a feature

A full list of contributors can be found in CONTRIBUTORS.md.

License

DiscordTickets is licensed under the GPLv3 license.

DiscordTickets is not related to Discord Inc.