Discord Controls

Discord Controls is an extension that gives you and your viewers a super easy way to run your Discord server right from SAMMI.

Features

• See Everything - Access a list of all channels, members, and emojis in your server.
• Find Anyone - Easily search for members and see their information.
• Manage Messages - View, make, change, or delete messages in your channel.
• Create Messages with Attachments and Embeds - Send messages with images, files, and embeds.
• Handle Reactions - Get, create, and remove reactions to messages.
• Send Direct Messages - Shoot private messages to members of your server.
• Take Care of Roles - View, add, or remove member roles - it's never been easier!
• Change Nicknames - Quickly change any member's nickname.
• Control Members - Mute, deafen, move, or time-out members to keep your server friendly and fun.
• Update Server - Change your server details, including its name and icon. You can even show when you're live with a simple 'live' overlay on your server icon!
• Rename Channels - Change any channel name whenever you want.
• Create invite - Create a new channel invite with options like maximum age and maximum usage.

With Discord Controls, running your Discord server is a breeze!

Setup

1. Install the extension. You can follow the Extension Install Guide.

2. Edit the INIT SETTINGS button in the Discord Controls premade deck. Here's what you'll need to do:

   • Discord Bot Token:

     1. Create a new application at Discord Developers.

     2. Go to the 'Bot' menu and click 'Add Bot' (if you get an error, try renaming the application).

     3. Enable the 'SERVER MEMBERS INTENT' and 'MESSAGE CONTENT INTENT' options (these are important for using the Get Members and Get Messages commands).

     4. In the 'Bot' menu, hit 'Reset Token' and copy this into the Discord Bot Token box in SAMMI.

     5. In the 'OAuth2 - URL Generator' menu, check the 'Bot' scope. You'll need to give the bot specific permissions for certain SAMMI commands.
        Here’s a list of required permissions:

        Command	Permission Required
        Get Messages	Read Message History
        Create Message	Send Messages
        Delete Message	Manage Messages
        Send DM	Send Messages
        Create Reaction	Read Message History, Add Reactions
        Add Role	Manage Roles
        Remove Role	Manage Roles
        Change Nickname	Manage Nicknames
        Mute	Mute Members
        Deafen	Deafen Members
        Move	Move Members
        Timeout	Moderate Members
        Create Event	Create Events
        Delete Event	Manage Events
        Modify Channel	Manage Channels
        Modify Server	Manage Server

     6. Copy the generated URL, paste it into your browser, and invite the bot to your Discord server.

     7. If you want to manage roles, make sure the bot’s role is higher than the roles you wish to modify in Discord Server Settings.

   • Default Discord Server ID: This is the ID of the Discord server you want to control. Here’s how to get it:

     1. In Discord, turn on Developer Mode (found in User Settings > Advanced).
     2. Right-click your Server name and click 'Copy ID'.

   • Amount of members to retrieve: Select how many members you want to display in the User ID dropdowns in DisCon commands. This makes it easier to choose members without searching for their ID manually.

3. Save the changes to the INIT Settings button, then save the whole deck. Reload your Bridge to activate the extension.

Once the extension is running, all DisCon commands will show dropdowns for channel, role, emoji, and member IDs. For using a different server in commands than the default one, you’ll need to input these manually.

Available Commands

Get Channels

Retrieves an array containing all channels in the server. Each channel is an object.

Example payload for a single channel object:

{
    "position": 1.0,
    "guild_id": "123477614154252318",
    "permission_overwrites": [
        {
            "allow": 0.0,
            "allow_new": "0",
            "deny_new": "1024",
            "id": "123477614154252318",
            "deny": 1024.0,
            "type": "role"
        },
        {
            "allow": 0.0,
            "allow_new": "0",
            "deny_new": "1024",
            "id": "123478636284641351",
            "deny": 1024.0,
            "type": "role"
        }
    ],
    "last_message_id": "1234199175164215347",
    "flags": 0.0,
    "nsfw": 0.0,
    "parent_id": "807277614154252319",
    "rate_limit_per_user": 0.0,
    "id": "936175293419368488",
    "type": 0.0,
    "topic": null,
    "name": "My Test Channel"
}

Get Members

Retrieves an array of current server members. Each member is an object.

Example payload for a single member object:

{
    "premium_since": null,
    "roles": [
        "999829629307199528",
        "807278636284641351"
    ],
    "flags": 0.0,
    "pending": 0.0,
    "joined_at": "2021-02-05T15:53:01.711000+00:00",
    "communication_disabled_until": null,
    "is_pending": 0.0,
    "mute": 0.0,
    "user": {
        "avatar_decoration": null,
        "public_flags": 0.0,
        "discriminator": "9031",
        "username": "Christinna",
        "id": "452058585715834890",
        "avatar": "76465f81d94b50023f2d51b63e6e57bd"
    },
    "nick": null,
    "avatar": null,
    "deaf": 0.0
}

Get Roles

Retrieves an array of all current server roles. Each role is an object.

Example payload for a single role object:

{
    "position": 0.0,
    "color": 0.0,
    "managed": 0.0,
    "icon": null,
    "flags": 0.0,
    "unicode_emoji": null,
    "hoist": 0.0,
    "mentionable": 0.0,
    "permissions": 104320577.0,
    "id": "807277614154252318",
    "description": null,
    "permissions_new": "1071698660929",
    "name": "@everyone"
}

Get Emojis

Retrieves an array of current server emojis. Each emoji is an object.

Example payload for a single emoji object:

{
    "managed": 0.0,
    "animated": 0.0,
    "roles": [],
    "url": "https:\/\/cdn.discordapp.com\/emojis\/1000155778554024066.png",
    "available": 1.0,
    "id": "1000155778554024066",
    "require_colons": 1.0,
    "name": "myEmoji"
}

Get User

Retrieves a single user object.

Example payload for a single user object:

{
    "banner_color": null,
    "banner": null,
    "banner_url": 0.0,
    "avatar_decoration": null,
    "accent_color": null,
    "public_flags": 0.0,
    "discriminator": "9031",
    "username": "Christinna",
    "avatar_url": "https:\/\/cdn.discordapp.com\/avatars\/452058585715834890\/76465f81d94b50023f2d51b63e6e57bd.png",
    "id": "452058585715834890",
    "avatar": "76465f81d94b50023f2d51b63e6e57bd"
}

Get Messages

Retrieves an array of channel messages. Each message is an object. Your Discord Bot must have READ_MESSAGE_HISTORY permission.

Example payload for a single message object:

{
    "components": [],
    "tts": 0.0,
    "pinned": 0.0,
    "attachments": [],
    "embeds": [],
    "mention_roles": [],
    "author": {
        "avatar_decoration": null,
        "public_flags": 0.0,
        "discriminator": "9031",
        "username": "Christinna",
        "id": "452058585715834890",
        "avatar": "76465f81d94b50023f2d51b63e6e57bd"
    },
    "edited_timestamp": null,
    "flags": 0.0,
    "channel_id": "807277614154252321",
    "content": "Hello world!",
    "mentions": [],
    "id": "1040363939843801128",
    "timestamp": "2022-11-10T20:34:52.286000+00:00",
    "type": 0.0,
    "mention_everyone": 0.0
}

Create Message

Creates a new message and returns a message object. Your Discord Bot must have SEND_MESSAGES permission.

Example payload for a single message object:

{
    "components": [],
    "tts": 0.0,
    "pinned": 0.0,
    "attachments": [],
    "embeds": [],
    "mention_roles": [],
    "author": {
        "avatar_decoration": null,
        "public_flags": 0.0,
        "discriminator": "2706",
        "username": "LBTwitch",
        "id": "815902341671813150",
        "avatar": null,
        "bot": 1.0
    },
    "edited_timestamp": null,
    "flags": 0.0,
    "channel_id": "807277614154252321",
    "content": "Hello world!",
    "referenced_message": null,
    "mentions": [],
    "id": "1040364294417686638",
    "timestamp": "2022-11-10T20:36:16.823000+00:00",
    "type": 0.0,
    "mention_everyone": 0.0
}

Edit Message

Edits a previously sent message. Must have been sent by the same Discord bot. Returns a message object.

Example payload for a single message object:

{
    "components": [],
    "tts": 0.0,
    "pinned": 0.0,
    "attachments": [],
    "embeds": [],
    "mention_roles": [],
    "author": {
        "avatar_decoration": null,
        "public_flags": 0.0,
        "discriminator": "2706",
        "username": "LBTwitch",
        "id": "815902341671813150",
        "avatar": null,
        "bot": 1.0
    },
    "edited_timestamp": null,
    "flags": 0.0,
    "channel_id": "807277614154252321",
    "content": "Hello world!",
    "referenced_message": null,
    "mentions": [],
    "id": "1040364294417686638",
    "timestamp": "2022-11-10T20:36:16.823000+00:00",
    "type": 0.0,
    "mention_everyone": 0.0
}

Delete Message

Deletes a single message. Your Discord Bot must have MANAGE_MESSAGES permission.

Send DM

Sends a new DM message. Your Discord Bot must have SEND_MESSAGES permission.

There are two steps required to send a DM:

1. Use DisCon Create DM command and retrieve the DM channel ID from the Save Variable response object.
2. Use DisCon Create Message command using the DM channel ID you retrieved from step 1.

Get Reactions

Retrieves an array of users who reacted to the specified message with the specified emoji. Each user is an object.

• For a custom emoji you can select it from the dropdown.
• For a regular Discord emoji, copy and paste the emoji (e.g., 👍 for thumbs up).

Example payload for a single user object:

{
    "avatar_decoration": null,
    "public_flags": 0.0,
    "discriminator": "9031",
    "username": "Christinna",
    "id": "452058585715834890",
    "avatar": "76465f81d94b50023f2d51b63e6e57bd"
}

Create Reaction

Creates a reaction to the specified message with the specified emoji. Your Discord Bot must have READ_MESSAGE_HISTORY, ADD_REACTIONS permissions.

- For a custom emoji you can select it from the dropdown.
- For a regular Discord emoji, copy and paste the emoji (e.g., 👍 for thumbs up).

Delete Reaction

Deletes your Discord bot’s reaction to the specified message with the specified emoji.

- For a custom emoji you can select it from the dropdown.
- For a regular Discord emoji, copy and paste the emoji (e.g., 👍 for thumbs up).

Add Role

Adds a specific role to the specified user. Your Discord Bot must have MANAGE_ROLES permissions and its own role must be ABOVE the role you're adding in Server Settings.

Remove Role

Removes a specific role from the specified user. Your Discord Bot must have MANAGE_ROLES permissions and its own role must be ABOVE the role you're removing in Server Settings.

Change Nickname

Changes a user's nickname in the server. Your Discord Bot must have MANAGE_NICKNAMES permission.

Mute

Mutes a user in a voice channel. Your Discord Bot must have MUTE_MEMBERS permission.

Deafen

Deafens a user in a voice channel. Your Discord Bot must have DEAFEN_MEMBERS permission.

Move Channel

Moves a user in a voice channel to a different voice channel. Your Discord Bot must have MOVE_MEMBERS permission.

Timeout

Times out a user in a server and prevents them from sending messages for a set period of time. Your Discord Bot must have MODERATE_MEMBERS permission.

To remove a timeout, set Timeout For to 0 and run the command again.

Search Member

Searches for a specific member in your server by their nickname. Returns an array of all users matching the search query.

Example payload for a single user object after searching for 'Chris':

{
    "premium_since": null,
    "roles": [
        "999829629307199528",
        "807278636284641351"
    ],
    "flags": 0.0,
    "pending": 0.0,
    "joined_at": "2021-02-05T15:53:01.711000+00:00",
    "communication_disabled_until": null,
    "mute": 0.0,
    "user": {
        "public_flags": 0.0,
        "discriminator": "9031",
        "username": "Christinna",
        "id": "452058585715834890",
        "avatar": "76465f81d94b50023f2d51b63e6e57bd",
        "bot": 0.0
    },
    "nick": null,
    "avatar": null,
    "deaf": 0.0
}

Get Events

Retrieves an array of all scheduled server events. Each event is an object.

Example payload for a single event object:

{
    "guild_id": "807277614154252318",
    "scheduled_end_time": "2023-05-17T07:00:00.133000+00:00",
    "channel_id": null,
    "creator_id": "452058585715834890",
    "sku_ids": [],
    "privacy_level": 2.0,
    "creator": {
        "avatar_decoration": null,
        "public_flags": 0.0,
        "discriminator": "9031",
        "username": "Christinna",
        "global_name": null,
        "id": "452058585715834890",
        "avatar": "76465f81d94b50023f2d51b63e6e57bd"
    },
    "image": null,
    "entity_id": null,
    "entity_metadata": {
        "location": "Earth"
    },
    "id": "1108246104262316114",
    "scheduled_start_time": "2023-05-17T05:00:00.133000+00:00",
    "description": "Hello description",
    "status": 1.0,
    "name": "Test event",
    "entity_type": 3.0
}

Create Event

Creates a new event. Your Discord Bot must have CREATE_EVENTS permission.

Delete Event

Deletes an existing scheduled event. Your Discord Bot must have MANAGE_EVENTS permission.

Modify Channel

Modifies a specified channel. Leave boxes empty to leave unchanged. Your Discord Bot must have MANAGE_CHANNELS permission.

Modify Server

Modifies a server. Leave boxes empty to keep current values unchanged. Your Discord Bot must have MANAGE_GUILD permission.

Encode Emojis

Encodes Unicode Discord emoji to be used in other Discord commands, such as 'Get Reactions' command.
Find full example inside the 'Get Reactions' command.

Format Emojis

Formats input containing Discord Unicode emojis to be used outside of Discord (e.g., Twitch chat), instead of displaying the raw Unicode.
Find full example inside the 'Get Messages' command.