Home

Welcome to the Geckarbot wiki and dev documentation!

The most important at first: The discord.py Documentation and Stackoverflow are your best friends!

If you want to setup the Geckarbot for first time, see the Bot configuration.

Some of currently available Plugins:

• Bot Management: Basic bot management features
• Role Management: Provides the bot role management and self-assignable roles via reactions
• DSC Plugin: DSC related commands and data
• Feedback Plugin: Provides and saves bot feedback for the devs
• Kwiss Plugin: Provides a Quiz
• Misc Plugin: Miscellaneous commands
• Number Guessing Plugin: Provides a number guessing game For the full list, see the plugin directory. Each plugin is namend after its .py file or subdirectory inside the plugin directory.

For developer:

We have following branches:

• Release branch for all releases, the release tags are based on this branch
• Hotfix branch for hotfixes for the current release, small Hotfixes could be commited directly, bigger please as regular Pull Request
• Development branch as basic development branch for all developer
• Each developer can make own dev branches or feature branches
• Pull Requests for new features are made into Development branch
• Hotfixes must also be merged into Development branch
• Before a release, the current Development branch will be merged into the release branch

Before a Pull Request, made a rebase/merge based on the branch you want to merge into to your branch.

After the Pull Request into Development branch is merged, please add the new features to the current upcoming release notes draft and update the documentation in the wiki!

All commands must be compliant to the Command Guidelines.

• Plugin and Data API: Basic usage of Plugin and Data API
• Useful functions and information: Some useful function and information for developing new bot features
• Listeners: Listeners for Reaction handling, Timer scheduling and DM handling
• Ignoring: Ignoring Subsystem to block users, commands and commands for specific users
• Presence Messages: Manage status messages which are displayed in the user list
• Help Command: Providing data for !help command
• Liveticker: Automatic liveticker handling for sport events like Bundesliga

Note on our basic structure, that the bot provides a framework to create own plugins which are providing the bots features:

• Plugins are modular files that provide commands for the user. They are completely optional from a technical standpoint.
• Core plugins are modular files that rely on specific global states in the bot itself or modify the behaviour of all other plugins. They don't have to be optional.
• Utils are tools that don't require a global state management and can be used by plugins at will. Since plugins rely on them, they are not optional once implemented (and used).
• Subsystems are tools that require a global state management and can be used by plugins at will. They are not optional and their global state is handled by the bot itself.

As permissions structre there are basically 4 roles:

• Serveradmin: For serveradmins, can execute almost every admin related thing like enabling and disabling plugins
• Botadmin: Can execute every command including pure bot related like restart the bot and debug commands
• Mods: Can execute moderation related commands like ignoring users
• User: Everyone else