mirror of
https://github.com/Hessenuk/DiscordTickets.git
synced 2024-11-05 04:13:08 +02:00
Update README and docs
This commit is contained in:
Isaac
parent
ab99830f60
commit
a54b9cbe74
152
README.md
152
README.md
@ -1,5 +1,151 @@
|
||||
# Please download from [releases](https://github.com/eartharoid/DiscordTickets/releases) or [v2 branch](https://github.com/eartharoid/DiscordTickets/tree/v2) - master branch is currently a work in progress
|
||||
<!-- omit in toc -->
|
||||
# ⚠️ Please download from [releases](https://github.com/eartharoid/DiscordTickets/releases) or [v2 branch](https://github.com/eartharoid/DiscordTickets/tree/v2) - master branch is currently a work in progress
|
||||
|
||||
https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=...
|
||||
The following information is about v3. Please read the README file on the v2 branch for information that is about the current version.
|
||||
|
||||
`npm i --production`
|
||||
<hr><br><br>
|
||||
<!-- new readme content -->
|
||||
|
||||
<img src='./docs/img/logo-small-circle.png' align='left' width='180px' height='180px' style='margin: 30px 40px 0 0'/>
|
||||
<!-- <img align='left' width='0' height='192px' hspace='10'/> -->
|
||||
|
||||
<!-- omit in toc -->
|
||||
# [DiscordTickets](https://discordtickets.eartharoid.me)
|
||||
|
||||
[](https://github.com/eartharoid/DiscordTickets/stargazers)
|
||||
[](https://github.com/eartharoid/DiscordTickets/stargazers)
|
||||
[](https://github.com/eartharoid/DiscordTickets/blob/master/LICENSE)
|
||||
|
||||
[](https://discord.gg/pXc9vyC)
|
||||
|
||||
An open-source ticket management bot for Discord - a free alternative to the premium and white-label plans of other popular ticketing bots.
|
||||
|
||||
<!-- omit in toc -->
|
||||
## Table of contents
|
||||
|
||||
- [What is this?](#what-is-this)
|
||||
- [Features](#features)
|
||||
- [Localisable](#localisable)
|
||||
- [Screenshots](#screenshots)
|
||||
- [Getting started](#getting-started)
|
||||
- [Documentation](#documentation)
|
||||
- [Support](#support)
|
||||
- [Contributing](#contributing)
|
||||
- [Contributors](#contributors)
|
||||
- [Sponsors](#sponsors)
|
||||
- [Donate](#donate)
|
||||
- [License](#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](https://tickettool.xyz/), [TicketsBot](https://ticketsbot.net/), [Tickety](https://tickety.net/), [Helper.gg](https://helper.gg/), [Helper](https://helper.wtf), 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](https://github.com/eartharoid/DiscordTickets/blob/master/.github/CONTRIBUTING.md#submitting-a-feature-request) if you think many other users would benefit from it
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### 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.
|
||||
|
||||
#### Localisable
|
||||
|
||||
If the bot hasn't already been translated to your (community's) language, you can [translate](https://github.com/eartharoid/DiscordTickets/blob/master/.github/CONTRIBUTING.md#translating) it yourself.
|
||||
|
||||
Plugin authors are encouraged to support multiple languages as well.
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### 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.
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### A beautiful ticket archives portal
|
||||
|
||||
Add the official [DiscordTickets-Portal](https://github.com/eartharoid/DiscordTickets-Portal) plugin for an instant ticket archives website.
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### 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](https://github.com/eartharoid/DiscordTickets-Portal) is an example of what can be done with plugins.
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### Open-source and self-hosted
|
||||
|
||||
It's yours.
|
||||
|
||||
<!-- omit in toc -->
|
||||
#### Supports multiple databases
|
||||
|
||||
DiscordTickets uses [Sequelize](https://github.com/sequelize/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**](https://discordtickets.eartharoid.me/installation) | [**Fully managed hosting**](https://go.eartharoid.me/discord) | [**Public test bot**](https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=475371285531066368) |
|
||||
|:-:|:-:|:-:|
|
||||
| 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 »](https://discordtickets.eartharoid.me/installation) | [Create a ticket on Discord »](https://go.eartharoid.me/discord) | [Add to Discord »](https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=475371285531066368) |
|
||||
|
||||
## Documentation
|
||||
|
||||
You will find most of information you need at [discordtickets.eartharoid.me](https://discordtickets.eartharoid.me).
|
||||
|
||||
## Support
|
||||
|
||||
If the [documentation](https://discordtickets.eartharoid.me) leaves you with questions, you can ask for help in the [discussions](https://github.com/eartharoid/DiscordTickets/discussions/categories/support-q-a) or join the support server on Discord.
|
||||
|
||||
[](https://go.eartharoid.me/discord)
|
||||
|
||||
## Contributing
|
||||
|
||||
For contributing instructions, or to find out all of the ways you can contribute, read [CONTRIBUTING](https://github.com/eartharoid/DiscordTickets/blob/master/.github/CONTRIBUTING.md). All contributions are welcome and encouraged, but please [read the information](https://github.com/eartharoid/DiscordTickets/blob/master/.github/CONTRIBUTING.md) 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](https://github.com/eartharoid/DiscordTickets/blob/master/CONTRIBUTORS.md).**
|
||||
|
||||
## Sponsors
|
||||
|
||||
Does your community or company use DiscordTickets? Sponsor the project to get your logo shown here.
|
||||
|
||||
### Donate
|
||||
|
||||
[](https://ko-fi.com/eartharoid)
|
||||
|
||||
## License
|
||||
|
||||
DiscordTickets is licensed under the [GPLv3 license](https://github.com/eartharoid/DiscordTickets/blob/master/LICENSE).
|
||||
|
||||
DiscordTickets is not related to Discord Inc.
|
||||
|
||||
© 2021 Isaac Saunders
|
||||
|
||||
@ -0,0 +1 @@
|
||||
# Changelog
|
||||
BIN
docs/img/logo-small-circle.png
Normal file
BIN
docs/img/logo-small-circle.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 27 KiB |
@ -1 +1,6 @@
|
||||
# Home
|
||||
# Home
|
||||
|
||||
<!-- todo: create an input field with javascript to automatically generate the url when user pastes their bot's id -->
|
||||
https://discord.com/oauth2/authorize?permissions=8&scope=applications.commands%20bot&client_id=...
|
||||
|
||||
`npm i --production`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user