forked from Galactic/galactic-bot
252 lines
9.6 KiB
Plaintext
252 lines
9.6 KiB
Plaintext
//Help Command
|
||
[C_HELP_DESCRIPTION]
|
||
Shows helpful information for commands, settings, and moderation.
|
||
|
||
[C_HELP]
|
||
**__HELP MENU__**
|
||
For a list of all available commands, use `{prefix}commands [ group ]`.
|
||
|
||
**❯ Arguments**
|
||
The bot splits arguments by space unless specified otherwise. To pass an argument that contains spaces you have to encapsulate it in quotes, some exceptions exist.
|
||
**Ex:**
|
||
`{prefix}grant "rolename that contains spaces" < permission >` - quotes are necessary
|
||
`{prefix}user some user` - quotes not necessary
|
||
**Typically** if the argument is at the end of a command it won't require quotes.
|
||
|
||
**❯ Documentation notation**
|
||
**Optional** arguments are denoted by being encapsulated in brackets `[ ]` - means that the command will run either with default values or show usage prompt.
|
||
**Required** arguments are denoted by less and greater than `< >` - means that the command will not run and return an error.
|
||
**Infinite** arguments (ones you can list several) are denoted by `..` after the argument. Ex `< argument.. >` - means you can pass more than one argument.
|
||
**Alternatives** are denoted by being separated by a `|`.
|
||
**Actual values** that you can use in a command are denoted by being surrounded by single quotes `' '`.
|
||
|
||
**❯ Moderation**
|
||
For help with moderation, see `{prefix}help modhelp`.
|
||
__**Warning:** This is a long embed.__
|
||
|
||
**❯ Command aliases**
|
||
Most commands and settings have some kind of aliases associated with them, some of which change the behaviour of the command or setting.
|
||
For instance the mute setting has a `createmute` (`{prefix}settings createmute <rolename>`) alias, which changes the behaviour to be identical to `{prefix}settings mute create <rolename>`.
|
||
|
||
**❯ Detailed usage of commands**
|
||
`{prefix}help [ command / setting ]`
|
||
|
||
**❯ Links**
|
||
[Support & Info server](https://discord.gg/SvJgtEj)
|
||
[@BotGalactic Twitter](https://twitter.com/BotGalactic)
|
||
[GalacticBot Patreon](https://www.patreon.com/galacticbot)
|
||
|
||
|
||
[C_HELP_TEMPLATE]
|
||
__**{component} HELP**__
|
||
{desc}
|
||
|
||
**Example usage**
|
||
{text}
|
||
|
||
|
||
[C_HELP_HELP]
|
||
Shows information about the bot and component usage.
|
||
To show help for commands `{prefix}help [command]`
|
||
|
||
[C_HELP_404]
|
||
Dude stop, {component} doesn't exist!
|
||
|
||
[C_HELP_TAGS]
|
||
**TAG SEARCH**
|
||
Commands and settings matching tag `{keyword}`.
|
||
For further help on how to use them, see `{prefix}help <component>`.
|
||
|
||
[MODHELP_TITLE]
|
||
**Moderation help menu**
|
||
|
||
[MODHELP_DESC]
|
||
**Galactic Bot** offers extensive moderation tools for servers, small and large, ranging from simple warnings and notes to mutes and tempbans. One of our more recent additions is automod. While not necessarily being a true automod, it'll keep track of moderation escalation for you with some configuration. Automod utilizes configurable modpoints and thresholds, for more information about automod see `{prefix}settings modpoints` and `{prefix}settings automod`.
|
||
|
||
**Galactic's** moderation commands can be viewed by using `{prefix}commands moderation`. The moderation utility follows a specific syntax for moderation, some parts allow for variation, while others require the arguments to be in specific locations in the command.
|
||
**The general syntax is:** `{prefix}<command> @user [time] [reason]`
|
||
|
||
Arguments that don't follow a strict pattern can be put anywhere **in the reason**. Such arguments are flags (and points, though they don't follow the same syntax as flags, more on that in a bit). For now there aren't many flags used by the moderation utility, though more may come in the future. The flags currently in use are `--force` and `--expires:<time>`, which are used to guide the automod.
|
||
|
||
[MODHELP_FIELD_1_NAME]
|
||
**❯ Moderation flags**
|
||
|
||
[MODHELP_FIELD_1_VALUE]
|
||
`--force` is the flag used to bypass automod, i.e. if you think automod will change your infraction due to a threshold being exceeded pass the `--force` flag to override.
|
||
**Ex:** `{prefix}warn @user 2pts obnoxious --force` - this would force the infraction to be a warning even if the points issued would cause the total amount of points to exceed a threshold.
|
||
|
||
`--expire <time>` is the flag used to tell the automod that a custom infraction expiration time should be used instead of the defined modpoints expiration value.
|
||
**Ex:** `{prefix}warn @user 2pts obnoxious --expires 2d` - This tells the system that the infraction will expire in 2 days, instead of whatever was configured in the setting.
|
||
|
||
`--silent` is the flag used to tell the bot not to DM the infraction the user if the bot otherwise was configured to do so.
|
||
**Ex:** `{prefix}ban @user really obnoxious --silent` - with default configuration the bot would DM the user when removed from the server, passing the `--silent` flag will stop the bot from doing so.
|
||
|
||
[MODHELP_FIELD_2_NAME]
|
||
**❯ Points**
|
||
|
||
[MODHELP_FIELD_2_VALUE]
|
||
Points are the point values defined either when running the command or in the modpoints setting. Issuing points is fairly simple, as they get picked up from anywhere in the **reason**, so long they follow the correct format. Points follow this pattern: `integer value points|point|pts|pt|p`. Any point values that exceed 100 will default to 100, and any point values that go below 0 will default to 0.
|
||
**Ex:** `{prefix}warn @user obnoxious 2 points`
|
||
|
||
[MODHELP_FIELD_3_NAME]
|
||
**❯ Infraction history**
|
||
|
||
[MODHELP_FIELD_3_VALUE]
|
||
Infraction history will always be logged to the bot's database regardless of text channel output. As such GalacticBot provides tools to search logs and filter them to some extent with flags, such as `--filter:warn` or `--exclude:mute`.
|
||
|
||
When viewing a user's infraction history, the total amount on **unresolved infractions** is shown, and if modpoints are enabled, their unexpired points as well. This does **not** mean that they are not displayed in their history!
|
||
|
||
[MODHELP_FIELD_4_NAME]
|
||
**❯ NOTE**
|
||
|
||
[MODHELP_FIELD_4_VALUE]
|
||
All flags and points will be parsed **out of the reason**, meaning that when issuing them they will not show up in the reason for the infraction. Points will be displayed in the infraction if the modpoints system is enabled and flags don't need to be displayed anywhere.
|
||
|
||
//Guild command
|
||
[C_GUILD_DESCRIPTION]
|
||
View data about the server.
|
||
|
||
[C_GUILD_TEMPLATE]
|
||
__Server information for **{name}**__
|
||
{description}
|
||
|
||
{emoji_owner} **Owner:** <@{owner}>
|
||
{emoji_booster4} **Boost tier:** {tier}
|
||
{emoji_booster3} **Boosters:** {boosters}
|
||
{emoji_calendar} **Date created:** {createdAt}
|
||
{emoji_region} **Voice region:** {region}
|
||
|
||
[C_GUILD_MEMBERS_NAME]
|
||
__Members__
|
||
|
||
[C_GUILD_MEMBERS]
|
||
{emoji_members} **Count:**
|
||
{memberCount}/{maxMembers}
|
||
{emoji_online} **Online:**
|
||
{approxPresences}/{maxPresences}
|
||
|
||
[C_GUILD_CHANNELS_NAME]
|
||
__Channels__
|
||
|
||
[C_GUILD_CHANNELS]
|
||
**Total:** {totalChannels}/500
|
||
{emoji_category-channel} **Categories:** {cat}
|
||
{emoji_text-channel} **Text:** {tc}
|
||
{emoji_voice-channel} **Voice:** {vc}
|
||
{news}
|
||
{store}
|
||
|
||
[C_GUILD_NEWS]
|
||
{emoji_news-channel} **News:** {news}
|
||
|
||
[C_GUILD_STORE]
|
||
{emoji_store-channel} **Store:** {store}
|
||
|
||
[C_GUILD_OTHER_NAME]
|
||
__Other__
|
||
|
||
[C_GUILD_OTHER]
|
||
{emoji_role} **Roles:**
|
||
{roleCount}/250
|
||
{emoji_sunglasses} **Emojis:**
|
||
{emojiCount}/{emojiTotal}
|
||
{emoji_flushed-awkward} **Gif emojis:**
|
||
{gifEmojiCount}/{emojiTotal}
|
||
|
||
[C_GUILD_FEATURES_NAME]
|
||
__Server features__
|
||
|
||
[C_GUILD_FEATURES]
|
||
{features}
|
||
|
||
[C_GUILD_NODESC]
|
||
No description set for guild, set one with `{prefix}set description <description here>`, alternatively the description of a community enabled server is shown here.
|
||
|
||
//User Command
|
||
[C_USER_DESCRIPTION]
|
||
Search for users or view user information.
|
||
|
||
[C_USER_DATA_NAME]
|
||
__User Data__
|
||
|
||
[C_USER_DATA]
|
||
**User:** <@{id}>{bot}
|
||
**Account created:** {created}
|
||
**Status:** {status}
|
||
**Activity:** {activity}
|
||
**Last global activity:** {globalActivity}
|
||
|
||
[C_USER_BADGES]
|
||
**Badges:** {badges}
|
||
|
||
[C_USER_MEMBER_NAME]
|
||
__Member Data__
|
||
|
||
[C_USER_MEMBER]
|
||
**Nickname:** {nickname}
|
||
**Server join date:** {joined}
|
||
**Last server activity:** {serverActivity}
|
||
|
||
[C_USER_MEMBER_ROLES]
|
||
**Roles:** {roles}
|
||
|
||
[C_USER_SEARCH_TITLE]
|
||
Search result for: `{key}`
|
||
|
||
[C_USER_SEARCH_FOOTER]
|
||
Found {matches} matches, displaying {count}
|
||
|
||
[C_USER_404]
|
||
{emoji_failure} No user found.
|
||
|
||
[C_USER_SEARCH_404]
|
||
{emoji_failure} No results found.
|
||
|
||
[C_USER_HELP]
|
||
To search server members with similar names use `{prefix}user search <arguments..>`
|
||
|
||
[C_USER_ROLES_TITLE]
|
||
__Member Roles__
|
||
|
||
//Commands Command
|
||
|
||
[C_COMMANDS_DESCRIPTION]
|
||
Displays all commands and help.
|
||
|
||
[C_COMMANDS_TITLE]
|
||
Commands
|
||
|
||
[C_COMMANDS_TEMPLATE]
|
||
Displaying commands for module `{mod}`.
|
||
|
||
{text}
|
||
|
||
[C_COMMANDS_FOOTER]
|
||
Commands that are struck through are disabled.
|
||
|
||
[C_COMMANDS]
|
||
To search by specific module, use `{prefix}commands [ module ]`.
|
||
You can also use `{prefix}commands [ command ]` for more information about the command.
|
||
|
||
//Prefix Command
|
||
[C_PREFIX_DESCRIPTION]
|
||
Displays the prefix that the server uses.
|
||
|
||
[C_PREFIX_SHOWPREFIX]
|
||
The guild's current prefix is **`{prefix}`**. You can also execute commands by mentioning me.
|
||
|
||
//Privacy Policy Command
|
||
[C_PRIVACYPOLICY_DESCRIPTION]
|
||
Displays the bot's privacy policy.
|
||
|
||
[C_PRIVACYPOLICY_PRIVACYDESCRIPTION]
|
||
Galactic (stable) and Galactic Canary (testing) bots only collect Discord user ID and message attachments (if applicable) data. We need your Discord user ID for remembering who you are, and your message attachments for logging tools for Discord server moderators. We use message attachments in order to view what users post after they're deleted by Discord, this ensures a safe place for users and a useful tool for moderators. This data is not shared with anyone. If you have questions or concerns about the bot, contact the developers in the Discord server [here]({invite}).
|
||
|
||
[C_PRIVACYPOLICY_DATA]
|
||
• Discord User IDs
|
||
• Message Attachments
|
||
|
||
To request removal of this data, reach out to the Developers [here]({invite}).
|
||
|
||
[C_PRIVACYPOLICY_OPTOUT]
|
||
You can opt-out of attachment storing by using the command `-set attachmentCache false`. |