rtbyte / rtbyte

An open-source modular multipurpose Discord bot built on the incredible Sapphire framework for discord.js

RTByte

Description

RTByte is an open-source modular multipurpose Discord bot built on the incredible Sapphire framework for discord.js. It brings a ton of features to help you run and manage your server. With an easy setup, you'll be up and running within minutes.

For more information about the project, and a link to add the bot to your server, please visit rtbyte.xyz. For support, please join our Discord server.

Development

Requirements

• Node.js: Node.js is required to run RTByte.
• PostgreSQL: Open-source relational database.
• Prisma: TypeScript ORM.

Optionals

• Sentry: Error monitoring & tracking (not yet implemented in current version).
• Google Maps Platform: Geocoding API.
• OpenWeather: Weather API.

A note regarding self-hosting RTByte

While RTByte is, and always will be, open-source, we're not very supportive of the idea of others self-hosting the bot. While you're completely free to host RTByte yourself, you will not receive any support from us in doing so.

Like many other open-source Discord bots, RTByte hasn't been built with the idea of self-hosting in mind. We use many different services to ensure we're able to deliver the best solution available.

• RTByte uses several external APIs. You'd need to create API keys in these for these to be able to fully use any features that may need them.
• RTByte uses PostgreSQL, an open-source relational database, to store persistent data. Prisma, a TypeScript ORM, is used to interface with said database.
• RTByte uses Sentry to track and monitor errors. Sentry is a paid service for which we've been granted an open-source license.

You can add RTByte to your server by visiting rtbyte.xyz/invite.

Contributors ✨

Thanks goes to these wonderful people:

rtbyte's Issues

Roles command not working if a member has a name similar to a joinable role

Describe the bug
The new membername feature being implemented across the board a couple weeks back, allowing mods to not have to @ a user when performing moderator actions on them. For the roles command, this breaks it if there's a member in the server with a similar name to a joinable role.

This issue can be circumvented by using -roles add @user role
Discovered in TMG Discord.

To Reproduce
Steps to reproduce the behavior:

1. Have a joinable role called minecraft and a user with a name starting with minecraft.
2. Have a user try to join it using -roles join minecraft
3. User is told to specify a role by it's name.

Expected behavior
The user is added to the role.

Screenshots
Error:

Workaround:

Sorting out all-contributors stuff

Don't mind me

Set up support for custom commands

Mods should be able to add, edit and remove simple custom commands. Should be limited to simple command/response commands.

TypeError: Cannot read property 'id' of null

Sentry Issue: RTBYTE-F

TypeError: Cannot read property 'id' of null
  File "/root/rtbyte/src/lib/structures/ModEmbed.js", line 72, in ModEmbed.send
    return await this.modCase.user.send(this.modCase.moderator.id === this.client.user.id ?
  ?, in runMicrotasks
  File "/root/rtbyte/src/events/rtbyteGuildBanAdd.js", line 36, in async module.exports.run
    await embed.send();

Moderation case system

Implementation of a moderation case system, storing information on all moderator actions taken on a server. Current implementation can be seen here.

I think it would be interesting to improve on the implementation this time around, allowing for actions to be taken on specific cases after they've happened (such as reversing a ban by directly referencing the case). Possibly allow the user who had action taken against them to appeal it?

To note, this issue is only for the implementation of the case system itself as opposed to any commands or log events related to it.

This is dependent on #230.

Porting the role opt-in/opt-out role system

Channel category field shows null on messageDelete if verbose logging is enabled

Solution: hide channel category on messageDelete with verboseLogging if the channel doesn't have a category

Starboard not re-posting messages if it reaches the threshold, goes back under, and then reaches the threshold again.

Describe the bug
After a message has reached the starboard threshold and been added to the starboard, but it goes back under the threshold again, it can't be re-starred.

To Reproduce
Steps to reproduce the behavior:

1. Send a message.
2. Add stars until it reaches the threshold and is posted to the starboard.
3. Remove stars so it goes under the threshold again, causing it to be removed from the starboard.
4. Add stars so that it goes above the threshold again.

Expected behavior
The message should be re-added to the starboard as it has now reached the threshold again.

Implementation of message filters

The three current types of message filters would need to be ported to the TS/Sapphire rewrite.

• Word blacklist
• Anti-invite
• Mention spam

This is dependent on #230 and #231.

Language file de-bloat and consistency

Go through the language file and consolidate naming schemes and langs. De-bloat by combining duplicate entries.

antiInvite doesn't trigger unless there is at least one invite link whitelisted

Expected behavior:

When filters.antiInvite is enabled and no invite links have been added to filters.inviteWhitelist, all invite links should be deleted.

Actual behavior:

When filters.antiInvite is enabled and no invite links have been added to filters.inviteWhitelist, the monitor triggers. After adding an invite link to filters.inviteWhitelist, the monitor triggers as normal.

DiscordAPIError: Cannot send messages to this user

Sentry Issue: RTBYTE-V

DiscordAPIError: Cannot send messages to this user
  File "/root/rtbyte/node_modules/discord.js/src/rest/RequestHandler.js", line 170, in RequestHandler.execute
    return reject(new DiscordAPIError(request.path, data, request.method, res.status));
  File "internal/process/task_queues.js", line 97, in processTicksAndRejections

This error has been appearing when starting the bot. I'd assume it's due to the guild initialization function checking to see if it's able to send messages to guild owners, but failing there. Would need testing.

- Rasmus

Emoji enlarging command

Essentially: take emoji as input => get source image which usually is a lot larger => return source image
Requested by 👑Jacket 👑#0001 in the Kinda Funny Discord.

Paginated -help command using RichMenu/RichDisplay

Requirements:

• Show different help embeds based on user's permissionLevel.
• Using custom emojis
• it's gotta look neat dude

Music feature

Issue to track progress of music command series

Set up welcome/goodbye function with support for user-provided placeholders

channelUpdate errors out on channels not in categories

0208073#diff-11482cd5a89daf3bab9d8186f6432317

Comment added on Line 37

Server log system

Much like the mod case system implementation from #231, we should implement a solution for generating server logs that doesn't rely on us creating a MessageEmbed for each feature that creates a server log message.

Should rely on types for;

• adding things (embed color green, examples below)
  • Member joining
  • Role added
  • Custom command created
• modifying things (embed color blue, examples below)
  • Message edits and deletions
  • Channel name changed
  • User's roles modified
• removing things (embed color red, examples below)
  • Member leaving
  • Channel removed
  • Custom command deleted

Color system is based on the current implementation and if we can think up a better one that takes things such as moderation actions into account as well with distinct colors for different things, that would be great.

Possibly other types to be implemented as well? Unsure, let's discuss.

guildMemberJoin and remove have stopped working

Timed mutes should display time until unmute

Expected behavior:

The embed footer should say User muted for X, with X displaying time until the unmute timestamp.

Actual behavior:

The embed footer says User muted until XXX, with X displaying Day Month Year, Time.

Mod action case system

Actively being worked on by @mcumbers, see mod-cases branch.

roleUpdate and channelUpdate spams the configured guild log channel with position updates

-conf show filters embeds any invite links if they've been added to the inviteWhitelist

Expected behavior:

Running -conf show filters shows the conf page as normal.

Actual behavior:

Running -conf show filters shows the conf page as normal, but embeds any invite links added to the inviteWhitelist.

 

Possible solution:

Instead of whitelisting by invite link, possibly whitelist by ID or guild object.

Update permission levels 9 and 10 to support multiple bot owners

Either through client.settings.botOwners or by adding another export to the config file.
Been trying to set this up but it's not working and I'm losing my mind.

TypeError: Cannot read property 'id' of undefined

Sentry Issue: RTBYTE-G

TypeError: Cannot read property 'id' of undefined
  File "/root/rtbyte/src/commands/Management/logs.js", line 275, in module.exports.set
    if (value.id === logChannel) return msg.reject(msg.language.get('COMMAND_LOGS_SET_CHANNEL_SAMECHANNEL', value));
  ?, in runMicrotasks

Moderation commands with timed versions where relevant

• Ban
• Softban
• Kick
• Mute (timed)
• Unmute
• Serverinfo
• Userinfo
• Warn
• Purge
• Send message
• VC kick
• VC ban (timed)
• VC unban

TypeError: Cannot read property 'action' of undefined

Sentry Issue: RTBYTE-K

TypeError: Cannot read property 'action' of undefined
  File "/root/rtbyte/src/events/rtbyteGuildMemberUpdate.js", line 36, in module.exports.run
    if (logEntry.action === 'MEMBER_UPDATE') executor = logEntry ? logEntry.executor === member.user ? undefined : logEntry.executor : undefined;
  ?, in runMicrotasks

Hungry Games Init

Want to start the HungryGames game/system

Include message attachments in message deletion events

Provide more context to the user in guildMemberUpdate's role update log

Describe the feature you'd like to see.
Improve the way the guildMemberUpdate log for role updates shows the user information. Make it more context-based, instead of just providing a list of roles.

Additional context
For servers where users have a lot of roles, things might get "lost in translation". Possibly provide info on what role was added/removed?

Support for reaction roles

Describe the feature you'd like to see.
Allow users to join a server's joinable roles using reactions on a set message other than just the roles command series.

All-contributors update

@all-contributors please add @ArtsyDiego for design.

Blacklisted words aren't filtered when surrounded by a set of characters

A blacklisted word surrounded by any set of characters is not detected by the word blacklist as it splits the message content up word by word and matches a word against the word blacklist.

Possible fix would be to split the message content up character by character and matching a series of letters in succession against the word blacklist.

Switch over any avatarURL() calls to displayAvatarURL()

avatarURL() returns the user's profile picture if they have one
https://discord.js.org/#/docs/main/master/class/User?scrollTo=avatarURL

displayAvatarURL() returns the user's profile picture if they have one, and their default profile picture if they haven't added one yet
https://discord.js.org/#/docs/main/stable/class/User?scrollTo=displayAvatarURL

i18next implementation

Describe the feature you'd like to see.
An implementation of i18next, and using it instead of the default language feature in Klasa. This will make it easier to work with translations, as it follows methods that many translation websites do.

Additional context
N/A.

Starboard feature

Starboard feature, there should be an example version in klasa-pieces. Fully configurable and designed as per our standards.

Banning via command causes two separate ban embeds

One of the ban embeds has (fc) at the end.

@Uzui2012, Stick mentioned why this happens in the dev channel, pls fix

Server- and userinfo embeds fail because of max field length

Urgent as bigger servers currently can't run serverinfo (tested on CC, AH)
Server- and userinfo embeds fail if the server has enough roles to (over)populate the list by hitting the max field length.

Possible solutions:

Solution 1: Limit it by showing the (10?) highest roles according to the role hierarchy.
Solution 2: Split the field before 1024 characters and add a second one if needed.

Weather API migration before end of 2021

Describe the feature you'd like to see.
We need to migrate from DarkSky's weather API to another weather API before the end of 2021 to ensure the continued functionality of the weather command. DarkSky is shutting down their API at the end of 2021.

Suggestions for new weather APIs:

• OpenWeather
• WeatherStack
• AccuWeather

Why would you wanna do this way

https://github.com/RTByte/RTByte/blob/e6151671420ee3352cbe6e1e7977c31a50282c46/src/index.js#L110
Not Really required

And you can basically do

new Client(config).login(token)

At line
https://github.com/RTByte/RTByte/blob/e6151671420ee3352cbe6e1e7977c31a50282c46/src/index.js#L112

Set up custom responses for missing parameters

Instead of having it show up as
member must be a mention or valid user ID.

It'd show up as something along the lines of this
Please @mention the user you'd like to ban

Bug: RangeError [EMBED_FIELD_VALUE]: MessageEmbed field values may not be empty.

Sentry Issue: RTBYTE-H

RangeError [EMBED_FIELD_VALUE]: MessageEmbed field values may not be empty.
  ?, in Array.map
  File "/root/rtbyte/src/events/rtbyteMessageUpdate.js", line 31, in module.exports.serverLog
    .addField(msg.language.get('GUILD_LOG_BEFORE'), truncate(old.content))
  File "/root/rtbyte/src/events/rtbyteMessageUpdate.js", line 21, in module.exports.run
    '{snip} s.get('channels.log') && msg.guild.settings.get('logs.events.messageUpdate') && old.content !== msg.content) await this.serverLog(old, msg);
  ?, in runMicrotasks
...
(5 additional frame(s) were not displayed)

Custom status support

Describe the feature you'd like to see.
Support for custom statuses in commands like userinfo

Additional context
Possible as of today because of discordjs/discord.js#3353

Set up mention spam monitor

Move permission langs to lang file

Move the permission langs in roleUpdate to the language file, so we can reuse them elsewhere

Site down

https://rtbyte.xyz/ -> Timeout

Pinboard feature

Pinboard feature, much like the Pinboard not but configurable as per our standards

Implementation of PostgreSQL with Prisma ORM

To replace the current implementation of Firestore.

https://www.postgresql.org/
https://www.prisma.io/

Fix linting for antiInvite monitor

Fix the linting for the antiInvite monitor so it's up to linting standards for the project (ESLint)

Update mod history command to display newest cases first