Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 3.06 KB

README.md

File metadata and controls

86 lines (56 loc) · 3.06 KB
Raw

Discord Bots


Ticketer

Welcome to the official GitHub page for the Ticketer bot! All of the source code is right here!
I advise you to only clone this repository for making pull requests, or making your own private version of the bot.
Consider starring the repository, all stars and forks are appreciated!
Do not make a public clone of the bot.

Support

Have questions or anything related to the bot? Join the Discord server.

Versioning

Ticketer uses its own versioning system, inspired by semantic versioning.

  • Major releases are for language rewrites (e.g javascript -> typescript) or multiple code and client-side breaking changes.
  • Minor releases are for client-side breaking changes (e.g renaming a command) or new client-side commands.
  • Patches are for bug fixes, performance enhances, chores, refactors, etc. Non bug-fixed patches can be released if they are 3+ of them.

Setup

Getting the Files

Obviously, you're gonna need the files to run anything. Get them by running git clone https://github.com/CarelessInternet/Ticketer.git.

Installing MySQL

You're gonna need MySQL to run this bot, please use this tutorial or similar to setup MySQL.

Creating .env File

In order to do anything with the bot, create a file named .env and add all necessary environment variables that can be found in src/environment.d.ts.
Don't forget to enable the Server Members, Presence Intent, and Message Content Intent for your bot.
Template:

DISCORD_BOT_TOKEN=
DISCORD_CLIENT_ID=
DISCORD_GUILD_ID=
DISCORD_OWNER_ID=
DB_HOST=
DB_USER=
DB_PASSWORD=
DB_DATABASE=
DB_PORT=

Installing Dependencies

Run the command npm i to install all dependencies. This is only needed once.

Building

Run the command npm run build to compile the files.

Creating MySQL Table

Run the command npm run mysql to create all necessary tables. This is only needed once.

Deploying Commands

Run the command npm run deploy to deploy the commands. This is only needed once if you're not adding new commands. If you are adding new commands, run this command when you have done so.

Running the Bot

Run the command npm start to run the bot.

Issues

If you can't get the bot to run, join the support server and create a support ticket.
For any bug reports, suggestions or general feedback, please submit an issue or join the support server.

Pull Requests

If you updated or created anything that benefits the bot, feel free to submit a pull request to be merged into the main branch.