Documentation

Coffee Bot is a Discord bot designed to facilitate coffee meetings and help members of a community connect with each other. It provides various commands to manage coffee roles and coffee meetings. This documentation will guide you through the available commands and their usage.

Table of Contents

Roles Command ~ Add ~ View ~ Remove ~ Self-Role Menu

Meeting Command ~ Description ~ Time ~ Toggle

Roles Command

The Roles command allows you to manage coffee roles in your server.

Add

To add a coffee role, use the following command:

/c roles add

This command creates a duplicate role with a coffee cup suffix. The new role can be assigned to users to enroll them in coffee meetings.

View

To view all coffee roles you've added and get more information about them, use the following command:

/c roles view

This command provides details about each coffee role you've added, such as role name, members assigned, and frequency.

Remove

To remove a coffee role, use the following command:

/c roles remove <role>

Replace <role> with the role you want to remove. This action permanently deletes the coffee role, so use it with caution.

Self Role Menu

To allow users to self-assign coffee roles, use the following command:

/c roles self-role-menu

This command sends a menu where users can select and assign coffee roles to themselves. It's recommended to use this command in a dedicated channel for easy access.

Meeting Command

The Meeting command is used to manage coffee meetings.

Description

To set the message that each user receives in their DMs when they've been matched for a meeting, use the following command:

/c meeting description

This command allows you to customize the invitation message for coffee meetings. You can also set the same message for every meeting by selecting the 'ALL' option in the drop-down menu that follows this command.

Time

To set the time for individual meetings or schedule all meetings for the same time, use the following command:

/c meeting time

This command enables you to specify the frequency and time for coffee meetings. You can also use the 'ALL' option to schedule all meetings for the same time.

Toggle

To disable or enable an individual coffee meeting, use the following command:

/c meeting toggle

This command allows you to toggle the status of a coffee meeting, enabling or disabling it as needed.