Develop 5.0.0

[eggy03]

Description

This PR adopts to the new schema used by the bot's API. The commands have undergone an overhaul and more customization options have been added. Customization options from the lite edition of the bot have also been added.

---

Changes

Commands

Audit Log and Message Log commands have been brought under the same roof.

• auditlog set,
• auditlog view,
• auditlog remove,
• messagelog set,
• messagelog view and
• messagelog remove

have been replaced by

• config save [guild_event_channel][member_event_channel][message_event_channel] ,
• config view and
• config update [guild_event_channel][member_event_channel][message_event_channel] respectively.

Starting v5, the bot categorizes events into 3 types:

• Guild Events,
• Member Events and
• Message Events

The new config commands allows you to assign a separate logging channel to each event category, giving you greater control over what your bot logs and where those events are sent.

Saving and Updating a Configuration

Use config save when creating a new configuration and config update when modifying an existing configuration.

For example, if you only want Message Events to be logged, you can use:
config save [ ][ ][message_event_channel]

or, if a configuration already exists:
config update [ ][ ][message_event_channel]

Leaving a channel unspecified automatically disables logging for that event category.

Important: config update replaces the entire existing configuration with the configuration provided in the command.

For example, if your current configuration has Member Events and Message Events enabled and you want to additionally enable Guild Events, you must provide all three channels when using config update. If you omit the existing channels, those channels will be cleared and logging for those event categories will be disabled.

Viewing a configuration

Use config view to view existing configuration for your guild.

Removing an existing configuration entirely

Use config update with no channels to remove your existing configuration.

Migration

If you are migrating from v2, 3 or 4, your existing guild data will be automatically migrated to the newer schema. Your existing server configuration will be migrated to work with the new schema.

Existing guild configurations will be mapped based on the following rules:

1. If a guild had a channel registered for Audit Log events, that channel will be assigned to both guild_event_channel and member_event_channel. If the guild also had a channel registered for Message Log events, that channel will be assigned to message_event_channel.
2. If a guild was registered only for Audit Log events, message_event_channel will remain empty. The bot will therefore not log messages or other message-related events for that guild.
3. If a guild was registered only for Message Log events, guild_event_channel and member_event_channel will remain empty. The bot will therefore not log guild- or member-related events for that guild.
4. If a guild was not registered for any logging before this update, its configuration will remain unchanged. You will need to use config save to create a new configuration.

You can use config view to verify whether your existing configuration matches with the new one.

setup has been renamed to help

More Customizations

Starting v5, you can allow for more customizations via environmental variables:

• APP_NAME - changes the app name used internally (defaults to PaperTrailBot)

• APP_ACTIVITY - changes the activity showed in discord (defaults to /help | latest version)

• EMBED_SUCCESS_COLOR_INT - changes the color of the embeds which log creation type events (for e.g., Role Create, Sticker Create) (defaults to GREEN (712458))

• EMBED_WARNING_COLOR_INT - changes the color of the embeds which log update type events (for e.g., Role Update, Sticker Update) (defaults to YELLOW (16776960))

• EMBED_DESTRUCTIVE_COLOR_INT - changes the color of the embeds which log deletion type events (for e.g., Role Delete, Sticker Delete) (defaults to RED (16711680))

Other Changes

Manual Sharding has been removed. This also means the bot is not capable of scaling horizontally anymore. I didn't want to bear the additional configuration burden associated with it.

---

Tasks for Native Builds

• New Code Added
  • New Code Tested In Native Build
• Dependencies Updated
  • Dependencies Updates Tested In Native Build
• Reachability Metadata Updated
  • Update Tested In Native Build