mirror of
https://github.com/zhiyan114/Firey-Bot.git
synced 2026-06-19 05:55:42 +00:00
Firey's Super User Account
- TypeScript 92.8%
- Python 3.2%
- JavaScript 1.9%
- Shell 1.1%
- Dockerfile 1%
|
|
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| __tests__ | ||
| extra | ||
| prisma | ||
| scripts | ||
| src | ||
| .deepsource.toml | ||
| .dockerignore | ||
| .env.example | ||
| .gitignore | ||
| .prettierrc | ||
| build.js | ||
| config.json.example | ||
| docker-compose.yml | ||
| Dockerfile | ||
| eslint.config.mjs | ||
| fly.toml | ||
| jest.config.js | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| prisma.config.ts | ||
| README.md | ||
| tsconfig.json | ||
Firey-Bot Internal Documentation
This bot is developed to serve a single server; thus, codes are not reusable without modification.
Environment Variable
For environment variable configurations, please refer to the .env.example file
Standard Configuration:
guildID- The guild ID for the server that the bot will be running in. Yes, I can technically pull that ID out by getting a list of guilds that the bot is in and read the first array, but nah, I don't feel like doing that.adminRoleID- As the name suggested, the roles that the user will be in with moderation privileges. For commands like eval, they do have exceptions.newUserRoleID- Role the new user will get after confirming.welcomeChannelID- Place to announce new users.logChannelID- Channels to send internal logs.generalChannelID- A general purpose chat channel for interactive repliesyoutubeNotification- Youtube Notification Configuration (a sub-config)guildChannelID- The ID of a guild's channel of where a new video will be postedpingRoleID- The role to ping as a reminderyoutubeChannelID- The youtube channel which it will be listening to
reactionRole- Disorganized reaction role system. IT was orginally developed without database in-mind because I didn't feel like setting them up.reactionLists- Put all the reactions in an array format which each object as{"Emote ID": "Role ID"}ChannelID- Which Channel is the reaction located. (To setup the reaction, look at the source on the top and use eval. This might change in the future)messageID- The message ID which the reaction will be listening to. I could of use the same technique mentioned above but eh not feeling it.
twitch- Twitch Bot configurationprefix- Prefix to invoke the botchannel- Twitch channel name that the bot will be listening in.discordChannelID- The channel ID in discord to send the notification toroleToPing- The role ID to ping when stream startsreminderInterval- Interval to send a reminder for the discord server (in ms)
noPointsChannel- A list of channels that the points will not be awarded toenableExtra- A list of extra services that can either be enabled or disableduserReport- Enables user to report software bug via sentry user-feedback
Add commands
All commands are in their respective folders under src/commands. To add commands, please make sure to update index.ts and inside src/events/helper.
To ensure command is compatible, import baseCommand from core (or baseTCommand for twitch commands)