Tritan is a Discord.js bot that has many general-purpose features such as logging, moderation, image manipulation, music, and much more!

Tritan Bot

Tritan Bot is a Discord Verified general purpose bot built with discord.js and express (yes, it has a dashboard included). Please read through the docs before even thinking about running this yourself.

Important: Read Me

You can self-host Tritan Bot, however you must follow the licensing by not changing any origional credits- as well as giving credit in your version of the bot via embed footers, website footers, and any other place deemed worthy by the creator. The creator has full discression to take away privileges to host the bot yourself, and if you fail to comply with the licensing legal actions may be taken. I have no problem making my creation open souce for learning purposes, as long as you contribute for any changes via a pull request and you give credit to my github page as the creator of the bot and website.

Can I add Tritan Bot to my server?

Yes, please go here to invite the bot. If you require support, or you would like to give any feedback or suggestions, please join the support server.

Documentation

While there is no documentation to run Tritan Bot yourself because it's not suggested, please visit this website for more information on the commands and setup available.

Features & Commands

Note: The default prefix is *

• Play music from YouTube via url
• Play music from YouTube via search query
• Play music from Soundcloud via url
• Search and select music to play
• Play youtube playlists via url
• Play youtube playlists via search query
• Now Playing
• Queue system
• Loop / Repeat
• Shuffle
• Volume control
• Lyrics
• Pause
• Resume
• Skip to song # in queue
• Help Command
• Media Controls via Reactions
• Enhanced Logging
• Easy to Use Utilities
• Necessary but Enhanced Infractions
• Join/Leave Logging
• Ban Logging
• Unban Logging
• Kick Logging
• Channel Creation/Deletion Logging
• Channel Update Logging
• Role Creation/Deletion Logging
• Role Update Logging
• Deleted Message Logging
• Message Purging with Logs
• Gifs for everything
• Fact commands
• Topic commands
• Memes
• Quotes
• Suggestions
• User information
• Fetch User ID
• Fetch Avatar
• Moderation Tools
• Clean, Kick, Ban, Warn
• AFK System
• and many more commands!

Should I Run Tritan Bot Locally?

Probably not. Tritan Bot has enough moving pieces that running a local version is complicated. The main purpose of having the source released is to allow others to understand and audit the functionality. The code is by no means meant to be easy to setup or bootstrap, and I don't plan on supporting folks trying to run locally. That said, feel free to run a local version of Tritan for your server (but not a public version please).

Self-hosting Agreement

• You may not use the Tritan logo or name within derivative bots.
• You may not host a public version of Tritan Bot.
• You may not charge for the usage of your instance of Tritan Bot.
• You may not provide support for Tritan Bot.
• You may not remove any credits to the original author anywhere within this bot. I know what code I've written, and I will recognize it.

Requirements

1. Discord Bot Token Guide
2. YouTube Data API v3 Key Guide
   2.1 (Optional) Soundcloud Client ID Guide
3. NodeJS v16.6.1 or Higher
4. At least 4GB of Ram
5. MongoDB Guide
6. Dedicated IP

Note:

As the creator and developer, I fully 100% support running this through docker. Do as you wish, I've included instructions for both the docker-compose and standalone way.

Getting Started - Standalone

git clone https://gitlab.com/team-tritan/tritan-bot-v5.git
cd tritan-bot
cd bot
npm i
cd ../ && cd web
npm i

Configuration - Standalone

You will need to fill in everything that is blank in the `config` directory. It can be confusing, but it's super easy once you know what you're doing. If you require any assistance please join our support server.

Start Up - Standalone

After installation finishes you can use pm2 to run this bot and web dashboard seperately. You must start these scripts from within their own directory, using node ../../../index.js will NOT work!

pm2 start manager.js --name Tritan-Sharding
-- pm2 stop Tritan-Sharding
-- pm2 restart Tritan-Sharding

Then

(Web) Dashboard:
cd ./web
pm2 start index.js --name Tritan-Web
-- pm2 stop Tritan-Web
-- pm2 restart Tritan-Web

pm2 save
pm2 startup

Contributing

Can I contribute?

Maybe. Feel free to submit PRs and issues, but unless they are explicitly bug fixes that have good documentation and clean code, I likely won't merge. Features will not be accepted through PR unless stated elsewhere. Do not submit feedback on this repository, the server is the right place for that. PRs focused around the frontend and web panel are more likely to be accepted.

1. Fork the repository
2. Clone your fork: git clone https://gitlab.com/your-username/tritan-bot.git
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request

Credits

• Tritan Bot is currently being maintained by Tritan Development and their team of developers.
• Created by Dylan James.
• Contributed to by Windows, Crafterzman, and MaximKing.