TribalBot-rewrite

Collaborative project to rebuild Tribal Bot a new. All hands accepted

Project structure

tribalbot/
    src/               => the project's logic
        bot/           => all the bot's components and setup logic
            cogs/      => all bot's cogs (extensions)
        orm/           => all database logic and interactions
            models.py  => each model represents a table. 
        controllers/   => Contains code that communicates the database with the commands
        utils/         => contains additional code like views, autocompletes and helpers
    __main__.py        => does final preparations and launches the bot

Code Style

The project uses a mixture of OOP and functional programing. The database and it's models should be fully OOP The bot's cogs are classes but commands should be designed following a functional approach.

command style

Ideally all the output of the bot should come in the form of embeds except for short ephemeral messages Embed colors should be saturated greens and oranges The terminology of the bot and its commands should reflect a tribal style

Development notes:

The code for the bot is organized into a module tribalbot The bot depends on the following environmental variables: - DATABASE_URL => the url for the database connection, must include the user and password (except sqlite) - BOT_TOKEN => the discord token for the bot

When the program starts it will look for an .env file at the project's root, you can put the environmental variables there.

Database

The program is Database "agnostic" meaning it will work with either SQLite, PostgreSQL or MySQL.

Schema

Philosophy and cultural remarks

Tribe Definition

Tribe: A social division in a traditional society consisting of families or communities linked by social, economic, religious, or blood ties, with a common culture and dialect, typically having a recognized leader.

Tribes depicted throuout this bot does not belong to any particular culture around the world. Any and all similarities with real world cultures are marely accidental and coincidental.

Contributions

Please submit PRs to contribute as well as rising any issues you deem important.

Disclosure of Responsibility

TRIBAL BOT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, ARISING FROM, OUT OF OR IN CONNECTION WITH THE USE OF THIS BOT.