This project is currently very early in development.
- Suggestion and feedback channels
- Allow users to create tickets for feedback, suggestions, concerns, or ideas
- Anonymous posting and messaging options
- Unlimited feedback channels per guild, allowing you to organize by whatever categories you need
- Completely stateless--nothing from this feature is cached or stored by the bot
- Game management
- Display information on each game in a server
- Provide an interface to edit game details and settings
- Creation and management of categories, channels, and roles
- Provide an interface for players to join games
- Provide an interface for GMs to manually add players
- Character database
- Display name, brief and long descriptions, optionally an image, optionally pronouns
- Decoupled character and player lists
- Keep track of original character author, even if transferred to another player
- Safety tool management
- Keep track of safety tool information per-game
- Easy, anonymous additions
- Session management
- Keep track of sessions and display using discord events
- Allow for postponement or rescheduling
- Set nicknames of players to character names during a session
- Tools for organizing session recap/synopses
- Automatic links to livestreams
- Ready Check
- Ping participants of a game ahead of time
- Gather responses from participants
- Show results at a glance
To install all dependencies, simply run
pip install -r requirements/all.txtYou'll also need to create a copy of example.config.yml and fill in all missing values.
To run the project locally:
python -m modron -c path/to/your/config.yml
This project also uses Nox to automate some development tools. To run these tools:
# run code style, spell check, and lint
nox -s lint
# run type checking
nox -s typecheck
# run tools to automatically/interactively fix some style, spelling, and lint issues
nox -s fixesThis project is powered by the awesome projects Hikari, Crescent, Flare, and hikari-toolbox.