Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,22 @@ Goose currently offers three commands to manage events in the society server:
- `edit_event` (event_id: int)
- `cancel_event` (event_id: int)

They handle events across Discord (both Scheduled Events and Event Announcements) and Google Calendar.
They handle events across Discord (both Scheduled Events and Event Announcements) and Google Calendar. Permissions for access to the commands should be set on the Server Settings rather than programatically to provide a better UX.

## Running

### Environment Variables

For development, `./goose/.env` is used. Please contact me (@VulcanShot) if you need this file. For Docker, the envars are pulled from `prod.env` and injected directly to the container.

- `GUILD` (development only): Server ID, used to facilitate development without having to wait for Discord to acknowledge changes in the bot
- `EVENTS_CHANNEL`: Channel ID where the bot should send event announcements
- `CALENDAR_ID`: Calendar ID, using Google Calendar at the moment
- `PUBLICITY_ROLE`: Role ID for the Publicity (formerly known as Marketing) Officer Role, used to ping them to request images for events
- `BOT_TOKEN`: Discord Bot Token (found on Discord Developer Portal and Vaultwarden)

### Credentials

Since we are using Google as our calendar provider (and as an improvised DBMS, to be honest), we have generated a [service account](/google_credentials.json) to use the API. Please contact me if you need valid credentials. Avoid creating new service accounts for testing purposes.

It is not included directly in the image, but as a read-only volume.
It is not included directly in the image, but as a read-only volume.
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
dateparser==1.4.0
discord.py==2.7.1
dismoji==0.3.1
google_api_python_client==2.194.0
protobuf==7.34.1
dismoji==0.4.0
google_api_python_client==2.196.0
protobuf==7.35.0
python-dotenv==1.2.2