Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.54 KB

README.md

File metadata and controls

23 lines (18 loc) · 1.54 KB
Raw

Andromeda

Andromeda is a bot that does alot of stuff :D

No I did not make this repo to avoid being sued

Make suggestions over in the Issues tab!

Configuration

  1. Create a new file called .env.
  2. In that file, add a new line: DISCORD_TOKEN=(token), replacing (token) with your bot token.
  3. On the next line, put SQLALCHEMY_URI=(database_url), replacing (database_url) with your database URL, for those just looking to contribute, you can simply use sqlite:///relative/path/to/db.db, or sqlite:////absolute/path/to/db. However, if you are running in production, you should use a database like PostgreSQL.
  4. (Optional) If you are in a scenario where the host of the bot is not the one who "owns" it according to Discord, you can add TRUSTED_UERS=user,ids,seperated,by,commas to add yourself as a trusted user.

Setting up the filter cog

The filter cog is a filter designed to delete messages with bad words in them. Unless you have cloned https://github.com/mogade/badwords, the cog will be disabled.

Configuring the database

Run alembic upgrade head

Running

Andromeda uses a Pipenv. In order to run the bot, you can use pipenv install, to install dependencies, and then you can run pipenv run python bot.py to run the bot.

Contributing

If you are looking to contribute, please note that because there are other devs helping too, meaning we require that any new packages that are required must be installed through pipenv install <package>, otherwise you will break the deployment for others.