-
-
Notifications
You must be signed in to change notification settings - Fork 37
Commands
Auto generated command manual | Sat, 13 Jan 2024 13:26:41 UTC
Create, revoke or list user reports.
| Domain Name | sp.guild.mod.report |
| Version | 1.2.0 |
| DM Capable | false |
-
sp.guild.mod.report.list- List a users reports. -
sp.guild.mod.report.warn- Warn a member. -
sp.guild.mod.report.revoke- Revoke a report.
File a new report. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| type | Integer |
true |
The type of report. | - warn (3)- ad (4) |
| user | User |
true |
The user. | |
| reason | String |
true |
A short and concise report reason. | |
| imageurl | String |
false |
An image url embedded into the report. | |
| expire | String |
false |
Expire report after given time. |
Revoke a report. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
ID of the report to be revoked. | |
| reason | String |
true |
Reason of the revoke. |
List the reports of a user. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
true |
User to list reports of. |
Lock or unlock a channel so that no messages can be sent anymore.
| Domain Name | sp.guild.mod.lock |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
false |
The channel to be locked or unlocked (selects current channel if not passed). |
Enable, disable or show state of invite blocking.
| Domain Name | sp.guild.mod.inviteblock |
| Version | 1.0.0 |
| DM Capable | false |
-
sp.guild.mod.inviteblock.send[EXPLICIT]- Allows sending invites even if invite block is enabled
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| enable | Boolean |
false |
Set state to enabled or disabled. |
Setup the ghost ping system.
| Domain Name | sp.guild.mod.ghostping |
| Version | 1.0.1 |
| DM Capable | false |
Display the current status of the ghost ping settings.
Setup ghostping messages. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| message | String |
true |
The ghost ping message pattern. Use /ghostping help to get more info. |
Disable ghostping messages.
Display help about the message pattern which can be used.
Create a role selection.
| Domain Name | sp.guild.mod.roleselect |
| Version | 1.2.0 |
| DM Capable | false |
Create a message with attached role select buttons. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| content | String |
true |
The content of the message. | |
| role1 | Role |
true |
Role 1 | |
| role2 | Role |
false |
Role 2 | |
| role3 | Role |
false |
Role 3 | |
| role4 | Role |
false |
Role 4 | |
| role5 | Role |
false |
Role 5 | |
| role6 | Role |
false |
Role 6 | |
| role7 | Role |
false |
Role 7 | |
| role8 | Role |
false |
Role 8 | |
| role9 | Role |
false |
Role 9 | |
| role10 | Role |
false |
Role 10 |
Attach role select buttons to a shinpuru message (sent i.e. with /say) Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The ID of the message. | |
| role1 | Role |
true |
Role 1 | |
| role2 | Role |
false |
Role 2 | |
| role3 | Role |
false |
Role 3 | |
| role4 | Role |
false |
Role 4 | |
| role5 | Role |
false |
Role 5 | |
| role6 | Role |
false |
Role 6 | |
| role7 | Role |
false |
Role 7 | |
| role8 | Role |
false |
Role 8 | |
| role9 | Role |
false |
Role 9 | |
| role10 | Role |
false |
Role 10 |
Mute members or setup mute.
| Domain Name | sp.guild.mod.mute |
| Version | 2.0.0 |
| DM Capable | false |
Toggle mute/unmute state of a member. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
true |
The user to be muted/unmuted. | |
| reason | String |
false |
The mute reason. | |
| imageurl | String |
false |
Image attachment URL. | |
| expire | String |
false |
Expiration time. |
List muted members.
Move all members of the current voice channel to another one.
| Domain Name | sp.guild.mod.mvall |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
true |
Voice channel to move to. |
Clear messages in a channel.
| Domain Name | sp.guild.mod.clear |
| Version | 1.1.0 |
| DM Capable | false |
Clears the last message
Clear a specified amount of messages Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| amount | Integer |
true |
Amount of messages to clear | |
| user | User |
false |
Clear messages send by this User |
Removes either messages selected with ❌ emote by you or all messages below the 🔻 emote by you
ban a member with creating a report.
| Domain Name | sp.guild.mod.ban |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
true |
The user. | |
| reason | String |
true |
A short and concise report reason. | |
| imageurl | String |
false |
An image url embedded into the report. | |
| expire | String |
false |
Expire report after given time. |
Kick a member with creating a report.
| Domain Name | sp.guild.mod.kick |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
true |
The user. | |
| reason | String |
true |
A short and concise report reason. | |
| imageurl | String |
false |
An image url embedded into the report. |
Setup code execution of code embeds.
| Domain Name | sp.guild.config.exec |
| Version | 1.1.0 |
| DM Capable | false |
Setup code execution.
Disable code execution and remove stored credentials.
Set the enabled state true or false. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| enabled | Boolean |
true |
The enabled state of the code execution. |
Show the status of the current code execution setup.
Set the mod log channel for a guild.
| Domain Name | sp.guild.config.modlog |
| Version | 1.0.0 |
| DM Capable | false |
Set this or a specified channel as mod log channel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
false |
A channel to be set as mod log (current channel if not specified). |
Disable modlog.
Set a message which will show up when a user joins or leaves the guild.
| Domain Name | sp.guild.config.announcements |
| Version | 1.0.0 |
| DM Capable | false |
Set a message and channel for an announcement message. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| type | String |
true |
The announcement type. | - join (join)- leave (leave) |
| message | String |
false |
The message. [user] will be replaced with the username and [ment] with the mention. | |
| channel | Channel |
false |
A channel to be set. |
Disable announcements. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| type | String |
true |
The announcement type. | - join (join)- leave (leave) |
Set guild starboard settings.
| Domain Name | sp.guild.config.starboard |
| Version | 1.0.0 |
| DM Capable | false |
Set starboard settings. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
false |
The channel where the starboard messages will appear. | |
| threshold | Integer |
false |
The minimum number of emote votes until a message gets into the starboard. | |
| emote | String |
false |
The name or emote of the emote to be used for staring messages. | |
| karma | Integer |
false |
The amount of karma gain when a users message gets into the starboard. |
Disable the starboard.
Set the mod notification channel for a guild.
| Domain Name | sp.guild.config.modnot |
| Version | 1.0.0 |
| DM Capable | false |
Set this or a specified channel as mod notification channel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
false |
A channel to be set as mod notification channel (current channel if not specified). |
Disable mod notifications.
Set the voice log channel for a guild.
| Domain Name | sp.guild.config.voicelog |
| Version | 1.0.0 |
| DM Capable | false |
Set this or a specified channel as voice log channel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
false |
A channel to be set as voice log (current channel if not specified). |
Disable voicelog.
Add a voice channel to the ignorelist. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
true |
A voice channel to be ignored. |
Remove a voice channel from the ignorelist. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
true |
A voice channel to be unset from the ignore list. |
Show all ignored voice channels.
Set the permissions for groups on your guild.
| Domain Name | sp.guild.config.perms |
| Version | 1.0.0 |
| DM Capable | false |
List the current permission definitions.
Set a permission rule for specific roles. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| mode | String |
true |
Set the permission as allow or disallow. | - allow (+)- disallow (-) |
| dns | String |
true |
Permission Domain Name Specifier | |
| role | Role |
true |
The role to apply the permission to. | |
| role2 | Role |
false |
Additional role to apply the permission to. | |
| role3 | Role |
false |
Additional role to apply the permission to. | |
| role4 | Role |
false |
Additional role to apply the permission to. | |
| role5 | Role |
false |
Additional role to apply the permission to. |
Display help information for this command.
Toggle color reactions enable or disable.
| Domain Name | sp.guild.config.color |
| Version | 1.0.0 |
| DM Capable | false |
-
sp.chat.colorreactions- Allows executing color reactions in chat by reaction
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| enable | Boolean |
false |
Set the enabled state of color reactions. |
Manage guild autoroles.
| Domain Name | sp.guild.config.autorole |
| Version | 1.0.0 |
| DM Capable | false |
Display the currently set autorole.
Add a role as autorole. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| role | Role |
true |
The autorole to be set. |
Remove a role as autorole. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| role | Role |
true |
The autorole to be set. |
Unset all autoroles.
Manage guild auto voicechannels.
| Domain Name | sp.guild.config.autovc |
| Version | 1.0.0 |
| DM Capable | false |
Display the currently set auto voicechannels.
Add an auto voicechannel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| voicechannel | Channel |
true |
The voicechannel to be set. |
Remove an auto voicechannel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| voicechannel | Channel |
true |
The voicechannel to be set. |
Unset all auto voicechannels.
| Domain Name | sp.chat.quote |
| Version | |
| DM Capable | false |
Get channel contribution statistics.
| Domain Name | sp.chat.chanstats |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| mode | String |
true |
The analysis mode. | - messages (messages)- attachments (attachments) |
| channel | Channel |
false |
The channel to be analyzed (defaultly current channel). | |
| limit | Integer |
false |
The maximum amount of messages analyzed. |
Set or manage birthdays.
| Domain Name | sp.chat.birthday |
| Version | 1.0.0 |
| DM Capable | false |
-
sp.guild.config.birthday- Allows setting the birthday channel.
Set birthday message channel. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| channel | Channel |
true |
The birthday message channel. |
Unset birthday message channel.
Set your birthday. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| date | String |
true |
The birthday date in format (YYYY-MM-DD+TZ). | |
| show-year | Boolean |
true |
Whether or not to show the year in the birtday message. |
Remove your birthday.
| Domain Name | sp.chat.profile |
| Version | |
| DM Capable | false |
Send an embedded message with the bot.
| Domain Name | sp.chat.say |
| Version | 1.1.0 |
| DM Capable | false |
Send an embed message. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| message | String |
true |
The message content. | |
| color | Integer |
false |
The color. | - default (16761095)- cyan (48340)- red (13840175)- gray (11583173)- green (9159498)- lime (9159498)- orange (16485376)- violett (6953882)- yellow (16761095) |
| title | String |
false |
The title content. | |
| footer | String |
false |
The footer content. | |
| channel | Channel |
false |
The channel to send the message into (or to edit a message in). | |
| editmessage | String |
false |
The ID of the message to be edited. |
Send raw embed message. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| json | String |
true |
The raw JSON data of the embed to be sent. | |
| channel | Channel |
false |
The channel to send the message into (or to edit a message in). | |
| editmessage | String |
false |
The ID of the message to be edited. |
Get information about a user.
| Domain Name | sp.chat.profile |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
true |
The user to be displayed. |
Display users karma count or the guilds karma scoreboard.
| Domain Name | sp.chat.karma |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| user | User |
false |
Display karma stats of a specific user. |
Set texts as tags which can be fastly re-posted later.
| Domain Name | sp.chat.tag |
| Version | 1.1.0 |
| DM Capable | false |
-
sp.chat.tag.create[EXPLICIT]- Allows creating tags -
sp.chat.tag.edit[EXPLICIT]- Allows editing tags (of every user) -
sp.chat.tag.delete[EXPLICIT]- Allows deleting tags (of every user)
Show the content of a tag. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| name | String |
true |
The name of the Tag. |
List created tags.
Create or update a tag. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| name | String |
true |
The name of the Tag. | |
| content | String |
true |
The content of the tag. You can use markdown as well as \n for line breaks. |
Delete a tag. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| name | String |
true |
The name of the Tag. |
Show a raw tag. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| name | String |
true |
The name of the Tag. |
Quote a message from any chat.
| Domain Name | sp.chat.quote |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The message ID or URL to be quoted. | |
| comment | String |
false |
Add a comment directly to the quote. |
Create and manage votes.
| Domain Name | sp.chat.vote |
| Version | 1.0.0 |
| DM Capable | false |
-
sp.chat.vote.close[EXPLICIT]- Allows closing votes also from other users
Create a new vote. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| body | String |
true |
The vote body content. | |
| choises | String |
true |
The choises - split by ,. |
|
| imageurl | String |
false |
An optional image URL. | |
| channel | Channel |
false |
The channel to create the vote in (defaultly the current channel). | |
| timeout | String |
false |
Timeout of the vote (i.e. 1h, 30m, ...) |
List currently running votes.
Set the expiration of a running vote. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The ID of the vote or all if you want to close all. |
|
| timeout | String |
true |
Timeout of the vote (i.e. 1h, 30m, ...) |
Close a running vote. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The ID of the vote or all if you want to close all. |
|
| chart | Boolean |
false |
Display chart (default true). |
Displays information about the current guild.
| Domain Name | sp.chat.guild |
| Version | 1.0.0 |
| DM Capable | false |
Get, remove or setup the notify role.
| Domain Name | sp.chat.notify |
| Version | 1.0.0 |
| DM Capable | false |
-
sp.chat.notify.setup[EXPLICIT]- Allows setting up the notify role for this guild.
Get or remove notify role.
Setup notify role. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| role | Role |
false |
The role to be used as notify role (will be created if not specified). |
Get notifications in channels when someone goes live on Twitch.
| Domain Name | sp.chat.twitch |
| Version | 1.0.0 |
| DM Capable | false |
List all registered notifies for the guild.
Add a twitch user to be watched. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| twitchname | String |
true |
The username of the twitch user. | |
| channel | Channel |
false |
The channel where the notifications are sent into (defaultly current channel). |
Remove a twitch user from the watch list. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| twitchname | String |
true |
The username of the twitch user. |
Log in to the web interface.
| Domain Name | sp.etc.login |
| Version | 1.1.0 |
| DM Capable | true |
Display some stats like uptime or guilds/user count.
| Domain Name | sp.etc.stats |
| Version | 1.0.0 |
| DM Capable | true |
Get information how to submit a bug report or feature request.
| Domain Name | sp.etc.bug |
| Version | 1.0.0 |
| DM Capable | false |
Display some information about this bot.
| Domain Name | sp.etc.info |
| Version | 1.0.0 |
| DM Capable | true |
Show the shinpuru help center.
| Domain Name | sp.etc.help |
| Version | 1.1.0 |
| DM Capable | true |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| command | String |
false |
A specific command you want to know more about. |
Get the discord ID(s) by resolvable.
| Domain Name | sp.etc.id |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| resolvable | String |
true |
The name of a discord object. |
Calculate information about a Discord or Shinpuru snowflake.
| Domain Name | sp.etc.snowflake |
| Version | 1.1.0 |
| DM Capable | true |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| snowflake | String |
true |
The snowflake ID. | |
| type | Integer |
false |
The type of snowflake (will be determindes if not specified). | - discord (0)- shinpuru (1) |
Maintenance utilities.
| Domain Name | sp.maintenance |
| Version | 1.2.0 |
| DM Capable | true |
Flush dgrs state. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| reconnect | Boolean |
false |
Disconnect and reconnect session after flush. | |
| subkeys | String |
false |
The cache sub keys (comma seperated). |
Kill the bot process. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| exitcode | Integer |
false |
The exit code. |
Reconnects the Discord session.
Reloads the bots config.
Set a specific config value. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| field | String |
true |
The config fild path and name. | |
| jsonvalue | String |
true |
The value as JSON representation. |
Display information about a given guild. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The ID of the guild. | |
| json | Boolean |
false |
Dispaly output as JSON. |
Let shinpuru leave the specified guild. Arguments
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| id | String |
true |
The ID of the guild. | |
| owner-message | String |
false |
Send the given message to the owner og the guild. |
Set the 'now playing' state of the bot.
| Domain Name | sp.presence |
| Version | 1.0.0 |
| DM Capable | false |
| Name | Type | Required | Description | Choises |
|---|---|---|---|---|
| message | String |
false |
The presence message. | |
| status | String |
false |
The presence status. | - online (online)- idle (idle)- dnd (dnd)- invisible (invisible) |
Manage guild backups.
| Domain Name | sp.guild.admin.backup |
| Version | 2.0.0 |
| DM Capable | false |