Skip to content

tedesmac/gally

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gally

Gally is an modular discord bot written in python and designed to be easily extensible.

Commands

The bot only includes the following command, any other fuctionality must be added bya extensions.

Administrators

Command

Description

\add_admin

Bot owner only. Adds a server’s administrator.

Usage:

\add_admin <@user>

\del_admin

Bot owner only. Removes an administrator.

Usage:

\del_admin <@admin>

\list_admins

Admins only. Lists all the server’s administrators.

Usage:

\list_admins

Extensions

Command

Description

\ext

Bot owner only. List all the loaded extensions.

Usage:

\ext

\list

Bot owner only. Lists all the available extensions.

Usage

\list

\load

Bot owner only. Loads an extension.

Usage:

\load <extension name>

\rload

Bot owner only. Reloads an extension.

Usage:

\rload <extension name>

\uload

Bot owner only. Unloads an extension.

Usage:

\uload <extension name>

Miscellaneous

Command

Description

\list_conf

Admins only. Lists the server configuration.

Usage:

\list_conf

\repo

Puts a link to the bot’s git repository.

Usage:

\repo

Available extensions

Quotes

Add and manage quotes (see quotes.asciidoc)

Taboo

Play taboo (see taboo .asciidoc)

Adding an extension

An extension has the following structure:

extension_name/      // (1)
|- __init__.py
|- ext.py            // (2)
|- requirements.txt  // (3)
|- ...

Where:

  1. Is a directory called with the extension’s name.

  2. This file must be included and must contain the extension’s code and a setup function that tells the bot how to load the extension.

  3. Same as a pip’s requirement file. This file is optional and if included the bot will call pip and install the dependencies listed on it. Keep in mind that some libraries may have dependencies outside of python that cannot be installed with pip and must be manually installed instead.

The extension must be inside the directory gally/extensions, and can be loaded with the command \load <extension name>.

TODO

  • ❏ Implement Logging.

  • ❏ Add an ORM model for the database.

About

A modular discord bot.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages