Files
open-ticket/README.md
T
DJj123dj 001ae9f86a v1.1.1
Fixed README.md
2021-11-20 11:27:38 +01:00

65 lines
2.4 KiB
Markdown

# open-ticket
This is an open-source discord ticket bot, you can configure it and it comes with cool features like a transcript.
(WARNING: the bot's language is Dutch, there will be an English version soon!)
## features
- discord interaction buttons
- transcripts
- add/remove users from ticket
- custom colors & name
- has tickets for questions, partners & job applications
## installation
You need `node.js 16` to run this project, if you don't want to install `node.js 16` then there is a npm package that can help you.
You can clone this project for download.
### packages
- canvas => version `^2.8.0`
- discord.js => version `^13.2.0`
- express => version `^4.17.1`
- node-localstorage => version `^2.2.1`
The packages are also in package.json!
### node.js 16 package
if you don't want to install `node.js 16`, you can install this package too
- node => version ^16.10.0
_npm install node@16_
## running
you can run `node index.js` but i would recommend you to use `npm start`
if there are any errors, you can open an issue on github.
### config (required)
- `server_name` => the name from your server.
- `server_logo`=> the logo from your server.
- `bot_name`=> the bot's name.
- `main_color`=> the color used in all embeds.
- `auth_token`=> the bot's token (Discord Developer Portal)
- `botperms_role`=> the id from a role that can run admin commands with the bot.
- `prefix`=> the bot's prefix.
- `ticket_system/ticket_channel` => the channel where you are gonna put the !ticket msg.
- `ticket_system/ticket_category` => the category for tickets.
- `ticket_system/member_role` => this role doesn't have access to tickets
(WARNING: @everyone does have access to tickets, so make sure all members have a member role!).
- `ticket_system/transcript_channel` => the channel for transcripts.
- `ticket_system/enable_transcripts` => enable transcripts.
- `ticket_system/enable_category` => enable tickets in category.
### intents & permissions
In the discord developer portal in the "bot" panel you will find 3 switches under the title "Gateaway Intents". The following switches should always be turned on
- `SERVER MEMBERS INTENT`
- `MESSAGE CONTENT INTENT`
The bot needs `ADMINISTRATOR` permissions to work the best.
## credits
the package contains a license, there are also credits in the bot. It is forbidden to extract these licenses and credits from it!
_v1.1.1_
© 2021 - DJdj Development | [website](https://www.dj-dj.be) | [discord](https://discord.com/invite/26vT9wt3n3)