← Home

Embeds

The $embed command lets users create, edit, delete, and schedule embeds. To get a better idea of how this command is structured see the Discord.js embed docs.

Usage

• Signature: $embed [subcommand] [args]?
• Parameters:
  • subcommand: See list of subcommands
  • args: Depends on the subcommand
• Examples:
  • $embed list
  • $embed edit id_num-1

Subcommands

• help
• list
• queue
• dequeue
• show
• new
• edit
• save
• cancel
• delete
• setField
• deleteField
• addField

For all embed_id parameters, the naming rule is as follows: The id must be alphanumeric and may include dashes (-) and underscores (_) but no other special characters.

help

• Signature: help [editing]?
• Parameters:
  • Optional editing: If editing is passed, shows only field editing related subcommands
• Examples:
  • $embed help
  • $embed help editing

The help function for the embed command, will display a summarized version of the documentation found on this page.

↑ Top

list

• Signature: list
• Parameters: None
• Examples:
  • $embed list

Lists the ids of all embeds save in this server. Will be improved.

↑ Top

queue

• Signature: queue [embed_id] [channel] [time]
• Parameters:
  • embed_id: The id of an embed saved in the server’s embed list
  • channel: The channel to display the embed in, must be “mentioned” as part of the message
  • time: The time that the embed will be sent. See examples for valid datetime formats
• Examples:
  • $embed queue id912 #channel 2020-10-8 11:00 AM CDT
  • $embed queue id912 #channel 2020 10 8 11:00 AM CDT
  • $embed queue id912 #channel 2020 Oct 8 11:00 PM CDT
  • $embed queue id912 #channel 2020 October 8 11:00 PM CDT

Queues the embed with id embed_id to show up in the specified channel at the given time. If not enough arguments are given, the embed_id doesn’t follow the naming rules, the embed with id embed_id doesn’t exist, the channel doesn’t exist, or if the time is invalid, no embed will be queued and the user will be notified. If the embed already queued, then this will override the previous channel and time.

Valid datetime formats include:

• [YYYY]-[m]-[d] [hr]:[min] [AM|PM] [timezone]
• [YYYY] [m] [d] [hr]:[min] [AM|PM] [timezone]
• [YYYY] [month abbr.] [d] [hr]:[min] [AM|PM] [timezone]
• [YYYY] [month] [d] [hr]:[min] [AM|PM] [timezone]

See Mozilla’s docs for more information about valid datetimes. Chances are if it is parsable (i.e. not NaN), it is valid.

↑ Top

dequeue

• Signature: dequeue [embed_id]
• Parameters:
  • embed_id: The id of an embed saved in the server’s embed list
• Examples
  • $embed dequeue id912

Removes the embed with id embed_id from the queue, so it will not be automatically sent. If the embed_id doesn’t follow the naming rules or the embed with embed_id doesn’t exist, no embed will be removed from the queue and the user will be notified. If the embed was not queued in the first place, then nothing happens.

↑ Top

show

• Signature: show [embed_id]
• Parameters:
  • embed_id: The id of an embed saved in the server’s embed list
• Examples:
  • $embed show id912
  • $embed show ywer1Yw

Sends the data of the embed with id embed_id into the channel that the command was called in. If the embed_id doesn’t follow the naming rules or the embed with embed_id doesn’t exist, no embed will be shown and the user will be notified.

↑ Top

new

• Signature: new [embed id]?
• Parameters:
  • Optional embed_id: Set a specific id for the new embed.
• Examples:
  • $embed new
  • $embed new my_special-ID9

This subcommand will start editing a new embed with an autogenerated id, if an embed_id is not given. If the given embed_id doesn’t follow the naming rules or is the same as an existing embed, no embed will be edited and the user will be notified. This command does not save to the server’s embed list, so remember to $embed save!

↑ Top

edit

• Signature: edit [embed_id]
• Parameters:
  • embed_id: The id of an embed saved in the server’s embed list
• Examples
  • $embed edit my_special-ID9

This subcommand will open the editor to edit an embed with the given id embed_id. If the given embed_id doesn’t follow the naming rules or the embed with embed_id doesn’t exist, no embed will be edited and the user will be notified. If another embed is already being edited, the other embed will stay in the editor and the user will be notified.

↑ Top

save

• Signature: save
• Parameters: None
• Examples
  • $embed save

This subcommand will save the embed currently in the editor. If no embed is being edited, the user will be notified.

↑ Top

cancel

• Signature: cancel
• Parameters: None
• Examples:
  • $embed cancel

This subcommand will revert all changes done to the embed in the editor. Users have the option of confirming or cancelling the revert. On confirmation, changes to the embed in the editor will be discarded. Please note that this action is NOT reversible!

↑ Top

delete

• Signature: delete [embed_id]
• Parameters:
  • embed_id: The id of an embed saved in the server’s embed list
• Examples:
  • $embed delete id192
  • $embed delete myId-1

This subcommand will delete the embed with the given embed_id. If the given embed_id doesn’t follow the naming rules or the embed with embed_id doesn’t exist, no embed will be deleted and the user will be notified. Users have the option of confirming or cancelling the deletion. On confirmation, the embed will be removed from the server’s embed list. Please note that this action is NOT reversible!

↑ Top

setField

• Signature: setField [field_name] [args]
• Parameters:
  • field_name: A specific field’s name
  • args: Specific arguments given to the field_name, see below for more details.

This subcommand will set a value based on args to the field field_name. If the field_name is invalid, then no field will be added and the user will be notified. We will call fields with only one argument, value, simple fields, and others complex fields. For simple fields, args will simply be value. For complex fields, users must provide a subfield and its corresponding value.

↑ Top

deleteField

• Signature: deleteField [field_name] [args]?
  • field_name: A specific field’s name
  • args: Specific arguments given to the field_name, see below for more details.
• Examples:
  • $embed deleteField field 1
  • $embed deleteField author
  • $embed deleteField author name

This subcommand will remove a value or values based on the field_name from the field field_name. If the field_name is invalid, then no field will be deleted and the user will be notified. We will call fields with only one argument, value, simple fields, and others complex fields. For simple fields, simply pass in field_name with no args. For complex fields, if args are left empty, then the entire field will be deleted. Otherwise, specify which subfield with args. Unlike the separation of setField and addField, custom fields may be deleted using this subcommand. To delete custom field, set field_name as “field” and the args as the index of the custom field (starting at 0).

↑ Top

addField

• Signature: addField [name] | [value] | [inline]?
• Parameters:
  • name: The name of the custom field (appears like a title)
  • value: The value of the custom field (appears like a description)
  • Optional inline: Sets the field inline, defaults to false. To set field inline, pass ‘inline’ as the final argument
• Examples:
  • $embed addField name 1 | value 1 | inline
  • $embed addField someName | test

This subcommand will add a custom field with “title” name and “description” value. If inline is passed as the last argument, the field will be inline. If name or value is missing, no field will be added and the user will be notified. This subcommand is different from setField as the custom field is unspecified.

↑ Top

Field Name

These are the field names as specified by Discord.js.

author

• args
  • name [value]
  • icon_url [value]
  • url [value]

color

• args
  • [value]

description

• args
  • [value]

footer

• args
  • text [value]
  • icon_url [value]

image

• args
  • url [value]

thumbnail

• args
  • url [value]

title

• args
  • [value]

url

• args
  • [value]