To setup in a discord server, make sure to configure the integration for each of the commands, that is, they can only be accessed by a permitted role.
To host the app in your local machine:
- Create a .env file containing the following.:
DISCORD_TOKEN = [YOUR DISCORD TOKEN]
- Run main.py
-
/set_config
- Set the configuration for the bot. Thechannel
is where the bot will post the reminders andjammer
is the role which will be pinged. Should only be accessible to jam organizers. -
/create jam
- Create a new game jam reminder withtitle
,theme
,duration
, anddate
of the end of the jam. The reminders will be set based on theduration
(look up with config in database) and the enddate
. Should only be accessible to jam organizers. -
/timeleft
- Messages the time left for jam. -
/theme
- Messages the theme of the jam. -
/list
- Messages the list of jams. -
/reset
- Resets the bot. Should only be accessible to jam organizers.
- Assuming the bot is already hosted and runs in the discord server, setup the integration to allow the commands
/set_config
,/create jam
, and/reset
to be accessed only by the game jam organizers.
- Use the
/set_config
command to set channel and the jammer role.
- Use the
/create_jam
command to create a new game jam. Note that theyear
,month
,day
,hour
, andminute
pertains to the date for the end of the jam. As for the initial configuration for theduration
, the bot will remind in the following time before the end of the jam:- 2 days: 1 day, 12 hours, 6 hours, 1 hour
- 1 week: 3 days, 1 day, 12 hours, 6 hours, 1 hour
- 2 weeks: 1 week, 3 days, 1 day, 12 hours, 6 hours, 1 hour
- In the example, the start of the jam is 2023/3/25 23:59, since the
duration
is 2 days and theend of the jam
supplied is 2023/3/27 23:59.
- The game jam is now created and automatically started. Everyone in the server can use the
/timeleft
and/theme
to check the information.