gang-gang bot

This Discord bot is intended for use by the SALSA Discord Group.

The bot supports:

• Accepted, Declined, and Tentative roles for event management
• Maximum event size and waitlists
• Manually adding/removing attendees
• Syncs event posts to Discord and Google Calendar

To view events in a calendar format, send a request to https://groups.google.com/g/salsa-automation

Once approved, subscribe to the calendar

Usage

Commands

/event - Starts a DM sequence to create a new event

/my_events - List all events created by user and any marked as attending

/upcoming_events - Lists all upcoming events in the server

Roadmap

• Recurring events
• Event Images
• Accessibility
• Viewing, sorting, filtering events
• Localization
• Custom signup rules

Development

To obtain a Guild ID, open the Discord client on Desktop then go to User Settings > Advanced and enable developer mode. Right-click a server icon on the left to see a Copy ID option.

To setup a bot for development purposes, go to Applications then create a new application. Under Settings > Bot, there is an option to generate a token.

It is also recommended to create a new server for testing.

1. Install Go 1.19+

2. Create a config.yaml file with the Guild ID and Bot Token in the repo root. This file contains secrets and should not be committed to version control or uploaded online without encryption.

discord:
  guild_id: {{ DISCORD_GUILD_ID }}
google:
  calendar_id: {{ GOOGLE_CALENDAR_ID }}
secret:
  token: {{ DISCORD_BOT_TOKEN }}

If using Heroku, see docs/. For initial calendar setup, go here.

3. Add the bot to a server for testing. See this guide for detailed instructions. It is possible to invite a users to app test or create a link through the OAuth2 URL Generator.

Minimally, bot and application.commands scopes must be enabled with the ability to read/send messages.

https://discord.com/api/oauth2/authorize?client_id=920479421478076468&permissions=2147568640&scope=bot%20applications.commands

4. Start the bot by running go run cmd/gang-gang-bot/main.go from the root directory of the git repo.

5. A new Slash command /event should be available which still start a DM sequence for creating a new event.

Graphviz

Bot states can be visualized using graphviz. If the executable is installed, make viz can be used to generate graphs found in /internal/tools showing transitions between states based on user input.

Resources

• Visualizer for embed and components
• Discord API Documentation
• Discord.js Documentation
• discordgo