Skip to main content

Changelogs

Information

The changelog module allows staff members to create changelogs quickly and easily. When you use the changelog command you will get a popup where you can enter the changelog details, once you have entered the details the bot will send the changelog to the changelogs channel that visualizes the changelog in a nice embed.

Command(s)

<> Required () Optional

/changelog - Shows the changelog popup.

Configuration

The configuration options are located in the config.js file under the changelog section inside the modules object.

Options

config.js → modules → changelog
changelog: {
enabled: true, // Whether or not the changelog module will be enabled.
channel_id: '1144252240702472222', // The ID of the channel where the changelog will be sent. This channel should only be accessible by the bot and the staff team.
message_content: '', // The message content that will be sent above the changelog embed.
embed_enabled: true, // Whether or not the changelog embed will be enabled.
embed_title: '{title}', // The title of the changelog embed.
embed_description: '**Changes:**\n```{changelog}```\n**Extra Info:**```{info}```', // The description of the changelog embed.
embed_footer_text: 'Changelog by {author}', // The footer of the changelog embed.
embed_footer_icon: '', // The footer icon of the embed.
embed_author_name: 'Suggestion by {username}', // The author name of the suggestion embed.
embed_author_url: '', // The author url of the embed.
embed_author_icon: '{authorpfp}', // Whether or not the suggestion embed will have an author icon.
embed_timestamp: true, // Whether or not the changelog embed will have a timestamp.
embed_color: '#00ff00', // The color of the changelog embed.
embed_url: '', // The url of the responder embed
embed_fields: [], // The fields of the responder embed
}

Placeholders

This is a list of all the placeholders that you can use in the configuration shown above.

PlaceholderDescription
{title}The title
{changelog}The changelog list
{info}The extra info that may be provided in the changelog
{author}The username of the person who created the changelog
{username}The username of the person who created the changelog
{authorpfp}The profile picture of the person who created the changelog

Translations

The translations are located in the translation.js file. The translations are prefixed with module_changelog_.

translation.js
module_changelog_command_name: 'changelog',
module_changelog_command_description: 'Create a changelog message',
module_changelog_modal_title: 'New Changelog',
module_changelog_modal_title_label: 'Title',
module_changelog_modal_title_placeholder: 'Changelog 1.0.0',
module_changelog_modal_changes_label: 'Changes',
module_changelog_modal_changes_placeholder: 'Enter your changelog here...',
module_changelog_modal_info_label: 'Additional Information',
module_changelog_modal_info_placeholder: 'Enter your extra info here...',
module_changelog_success: '✅ Successfully sent changelog message in {channel}',

Showcase

Change log creation popup

Changelog

Change log created in the changelogs channel

Changelog