Discord Bot Command Guide
Learn more about the Acorn Bot's commands.
Overview: Displays your weekly availability and timezone.
Usage: /my availability
Parameters: None.
Overview: Sets your weekly availability which is used to coordinate the creation of events.
Usage: /set availability
Parameters: None.
Notes:
- If you have not set your timezone yet, you will be prompted to set your timezone before setting your availability.
- The initial select boxes are an easy interface to quickly set your weekday and weekend availability. Click the more options button to set your availability individually for each day with hourly slot precision.
Overview: Sets your timezone.
Usage: /set timezone <timezone>
Parameters:
timezone: enter a common North America timezone (ET,CT,MT,PT), orOther. EnteringOtherwill prompt a manual entry of the timezone.
Notes:
- If an ambiguous timezone abbreviation is entered (i.e.
AST), you may be prompted to disambiguate it. - https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations contains a list of accepted timezones.
Overview: Ask questions and make requests through conversation.
Usage: /chat <message>
Parameters:
message: specify message content to ask the bot.
Notes:
- You can have full conversations with the bot without the need to preface
messages with
/chatvia DMs.
Overview: Show info about your upcoming events and those you're waiting to be invited to. Also shows your daily event limit and a button to configure it.
Usage: /my events
Parameters: None.
Overview: Set your daily event limit (0–3).
Usage: /set daily_event_limit <limit>
Parameters:
limit: integer between 0 and 3.
Overview: Show a guide on how to use commands.
Usage: /help <command_name>
Parameters:
command_name(optional): which command to show help for. If left blank, shows all available user commands.
Overview: Add an interest to receive notifications (DMs) about.
Usage: /add notifications <notification>
Parameters:
notification: the interest to receive notifications for when events with this interest are being organized.
Overview: Add an interest to help Acorn Social and your
server's
moderators know what you are interested in. The bot can handle any interest;
thus,
you can type any interest you may have in the interest field.
Usage: /add interest <interest>
Parameters:
interest: the interest to add.
Notes:
- This command must be run in a server, not in DMs with the bot.
- Adding an interest applies only to the current server the command was used in.
- If the interest has not been submitted before, it will be sent to server moderators for review.
Overview: Find interests.
Usage: /browse interests <interest>
Parameters:
interest(optional): the interest to search for. If left blank, all top-level categories will be displayed instead.
Notes:
- Entering an interest that does not exist does nothing.
Overview: Displays all the interests you have added.
Usage: /my interests
Notes:
- This command will show all interests for all servers you are a part of.
- Interests marked with
*are relevant in the current server the command was used in.
Overview: Displays all interests you will receive notifications for.
Usage: /my notifications
Notes:
- Notifications marked with
*are relevant in the current server the command was used in.
Overview: Remove an interest to express you are no longer interested in it.
Usage: /remove interest <interest>
Parameters:
interest: the interest to remove.
Notes:
- Removing a non-existent or unowned interest has no effect.
Overview: Remove an interest to stop receiving direct messages about it.
Usage: /remove notification
<notification>
Parameters:
notification: the interest to stop receiving notifications for.
Notes:
- Removing a non-existent or unowned notification has no effect.
Overview: Closes an existing suggestion.
Usage: /close suggestion <name>
Parameters:
name: the name of the suggestion to close.
Overview: Create an event description with full flexibility.
Usage:
/create description_advanced <name> <description>
<min_people> <max_people> <interest>
<image_link>
<creation_min_people> <event_duration>
<event_start_delay> <open_suggestion_period>
<suggestion_info> <group_names> <group_type>
<vc_id>
Parameters:
name: the name of the event description.description: event information, will be displayed in the voice channel.min_people: the minimum number of people for an event to be scheduled and occur.max_people: the maximum number of people for the event.interest: the interest the event is for.image_link: a URL for the image that will be displayed for the event description.creation_min_people(optional): the minimum number of people needed to create an event. If set higher thanmin_people, events will not be created untilcreation_min_peoplesign up.event_duration(optional): the length of the event in hours.event_start_delay(optional): the earliest time from now an event can be scheduled in hours.open_suggestion_period(optional): how long a suggestion should be open in hours.suggestion_info(optional): a brief description for the event, will be displayed with the event suggestion.group_names(optional): the names of different groups will be displayed.group_type(optional): the type of group. Individual group schedules each group independently.vc_id(optional): the voice channel id if the event should be in the same voice channel every time
Overview: Automatically create a description for a new event based on provided information.
Usage:
/create description_auto <interest> <event_info>
<image_link>
Parameters:
interest: the interest the event is for.event_info: some general information of the event you want to create.image_link: a URL for the image that will be displayed for the event description.
Overview: Create a new event description.
Usage:
/create description <name> <description>
<min_people> <max_people> <interest>
<image_link> <vc_id>
Parameters:
name: the name of the event description.description: event information, will be displayed in the voice channel.min_people: the minimum number of people for an event to be scheduled and occur.max_people: the maximum number of people for the event.interest: the interest the event is for.image_link: a URL for the image that will be displayed for the event description.vc_id(optional): the voice channel id if the event should be in the same voice channel every time
Overview: Create a new group-based event description.
Usage: /create description_group
Parameters: None.
Overview: Creates a new suggestion.
Usage:
/create suggestion <name> <description> <min_people>
<max_people> <interest> <image_link>
<group_names> <group_type> <vc_id>
Parameters:
name: the name of the event description.description: event information, will be displayed in the voice channel.min_people: the minimum number of people for an event to be scheduled and occur.max_people: the maximum number of people for the event.interest: the interest the event is for.image_link: a URL for the image that will be displayed for the event description.group_names: the names of different groups will be displayed.group_type: the type of group. Individual group schedules each group independently.vc_id(optional): the voice channel id if the event should be in the same voice channel every time
Overview: Edit an existing event description.
Usage:
/edit description <old_name> <new_name>
<description> <min_people> <max_people>
<interest> <image_link>
<creation_min_people> <event_duration>
<event_start_delay> <open_suggestion_period>
<suggestion_info> <group_names> <group_type>
<vc_id>
Parameters:
old_name: the name of the description to edit.new_name(optional): the new name of the event description.description(optional): event information, will be displayed in the voice channel.min_people(optional): the minimum number of people for an event to be scheduled and occur.max_people(optional): the maximum number of people for the event.interest(optional): the interest the event is for.image_link(optional): a URL for the image that will be displayed for the event description.creation_min_people(optional): the minimum number of people needed to create an event. If set higher thanmin_people, events will not be created untilcreation_min_peoplesign up.event_duration(optional): the length of the event in hours.event_start_delay(optional): the earliest time from now an event can be scheduled in hours.open_suggestion_period(optional): how long a suggestion should be open in hours.suggestion_info(optional): a brief description for the event, will be displayed with the event suggestion.group_names(optional): the names of different groups will be displayed.group_type(optional): the type of group. Individual group schedules each group independently.vc_id(optional): the voice channel id if the event should be in the same voice channel every time
Overview: Retrieve all event descriptions in CSV format.
Usage: /get descriptions_csv
Parameters: None.
Overview: Retrieve event descriptions.
Usage: /get descriptions <event_name>
Parameters:
event_name(optional): the name of the event to get descriptions for.
Notes:
- If no event name is provided, all event descriptions will be retrieved.
Overview: Remove an existing event description from the server.
Usage: /remove description <event_name>
Parameters:
event_name: the name of the event description to remove.
Overview: Upload a CSV file of event descriptions.
Usage: /upload descriptions <file>
Parameters:
file: a CSV file with the columns:name|description|interest|event_occur_min_people|creation_min_people|max_people|event_duration|event_start_delay|open_suggestion_period|image_link|suggestion_info|group_names|group_type|vc_idto upload.
Notes:
- This command is generally used in tandem with
/get descriptions_csv, where moderators download the descriptions, edit the file, then reupload the descriptions.
Overview: Create an event listing.
Usage: /host event <event_name> <timezone>
<start_time> <month> <day>
Parameters:
event_name: the name of the event.timezone: the timezone thestart_timewill be based on , e.g.CT(options auto-fill).start_time: the start time of the event, e.g.12am(options auto-fill).month: the month to host the event, e.g.September(options auto-fill).day: the numerical day of the month to host the event, e.g.25.
Overview: Cancel hosting an event.
Usage: /host cancel <event_name>
Parameters:
event_name: the name of the event to cancel.
Overview: Show all server events you are hosting.
Usage: /my hosted_events
Parameters: None.
Overview: Show all available moderator commands or help for a specific command.
Usage: /moderator help <command_name>
Parameters:
command_name(optional): which command to show help for.
Overview: Upload the hierarchy.
Usage: /hierarchy upload <file>
Parameters:
file: the file which contains the hierarchy to upload.
Overview: Retrieve the hierarchy.
Usage: /hierarchy retrieve
Parameters: None.
Overview: Approve a pending interest.
Usage: /pending interest approve
<interest>
Parameters:
interest: the name of the pending interest to approve.
Overview: Reject a pending interest.
Usage: /pending interest reject
<interest>
Parameters:
interest: the name of the pending interest to reject.
Overview: List all pending interests.
Usage: /pending interests
Parameters: None.
Overview: Update the interest hierarchy automatically.
Usage: /update hierarchy_auto
Parameters: None.
Overview: Sends an embed message to a channel from the Acorn Bot.
Usage: /send embed <text> <interest>
<set_availability_button> <event_name>
Parameters:
text: the text to display in the embed.interest(optional): add an interest button to the message, where users can easily add this interest.set_availability_button(optional): add any text here to include a button where users can set availability.event_name(optional): the name of the event suggestion which should be created.
Overview: Show information about the different types of events.
Usage: /server event_info <event_name>
Parameters:
event_name(optional): the name of the event to get the information about.
Notes:
- If no
event_nameis provided, all events will be listed.
Overview: Show server setup information.
Usage: /server info
Parameters: None.
Overview: Get a list of interests ranked by the number of users with that interest added.
Usage: /server interests
Parameters: None.
Overview: Shows aggregate server availability data.
Usage: /server overall_availability <timezone>
<interest> <day>
Parameters:
timezone: the timezone to display the availability in.interest(optional): only include users with this interest added.day(optional): only show availability for a specific day of the week.
Notes:
- If no
interestis provided, it will display the availability for all users. - If no
dayis provided, it will display the availability for all days.
Overview: Mark a channel for specific types of Acorn Bot messages.
Usage: /setup channel <channel_type>
<channel>
Parameters:
channel_type: the type of the channel to set up, eitherevent suggestion channel,ongoing events channel, oradvertise events channel.channel: the name of the channel in the server to to set up.
Overview: Set where event VCs should be created.
Usage: /setup vc_category <category>
Parameters:
category: the name of the VC channel to set up.
Overview: Set up automation for suggestions.
Usage: /setup automation_suggestion
<status>
Parameters:
status: whether or not to set up automatic suggestions, options areenabledordisabled.
Overview: Set a role to use moderator commands.
Usage: /set role <role>
Parameters:
role: the name of the role which can now use moderator commands.
Overview: Set the frequency at which advertising messages for a specific event are sent.
Usage: /set advertise_delay <delay_time>
<delay_messages>
Parameters:
delay_time: the time span that must pass for another event advertisement to be sent.delay_messages: the number of new messages that must be sent in the advertisement channel for another event advertisement to be sent.
Notes:
- Both
delay_timeanddelay_messagesconditions must be met for another advertisement to be sent for a specific event. For example, ifdelay_timeis15 minutesanddelay_messagesis10, then both15 minutesmust pass and10new messages (not sent by the bot) must be sent in the advertisement channel for another event advertisement message to be sent.