Troy is a Discord bot being developed in kotlin using kord and kord extensions framework. Troy is mainly being developed around fun and moderation commands.
Troy needs several permissions to do what it is supposed to do. Every permission Troy needs is explained below.
Please note, Removing any of these permissions may break one or many commands.
- View Audit Log is self-explanatory
- Manage Roles is needed to mute members, Give them extra roles Troy needs this permission.
- Kick Members is self-explanatory.
- Ban Members is self-explanatory.
- Create Instant Invite is needed when you want to create an invitation link whenever you are feeling lazy.
- Manage Nickname is needed to manage nicknames across your server.
- Change Nickname is needed to change other's nickname.
- View Channels is self-explanatory
- Read Message is self-explanatory.
- Send Message is self-explanatory.
- Public Threads is self-explanatory.
- Private Threads is self-explanatory.
- Send message in Threads is self-explanatory.
- Manage Messages is needed for purge command where you need to delete messages in bulk.
- Manage Threads is needed for future commands related to thread creation and updating from Troy with handy commands.
- Embed Links is needed because Troy utilize Discord Embeds heavily and denying this permission will break so many commands.
- Attach Files is needed for upcoming images related commands.
- Read Message History is needed to fetch case numbers while moderation command gets fired.
- Add Reactions is self-explanatory.
- Voice related permissions are needed for music commands.
If any new permission is required, You can find an explanation here.
Before you begin
- Make sure you have IntelliJ Idea setup and ready.
- Clone Repository.
- Change your directory to troy with
cd troyafter cloning. - Create a file named
.envin root directory and fill it out as shown in.example-env.
After you are done with the prerequisites above, Just build FatJar or run Main class in
Main.kt file from your IDE.
Note: I will add a thorough guide to set up the bot on Linux, Windows or Mac system in near feature. Meanwhile, if someone wants to cover this, Open an issue and submit a Merge Request.
Please take a look at the contributing guidelines if you're interested in helping by any means.
Contribution to this project is not only limited to coding help, You can suggest a feature, help with docs, enhancements ideas or even fix some typos. You are just an issue away. Don't hesitate to create an issue.
MIT License Troy is available under terms of MIT license.
Copyright (c) 2024 TechnoWolf FOSS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.