Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 2 KB

README.md

File metadata and controls

26 lines (21 loc) · 2 KB
Raw

Discord bot

Build Status

Website: dtat.hampl.space

Bot: invite

API: Postman

Running the bot

  1. To run the server, you will need url to a running main server. You can either host it yourself, or connect to the one hosted at dtat.hampl.space.
  2. Create a virtual environment with Python 3.6 (discord.py doesn't support v3.7)
  3. Enter into virtual environment
  4. Install requirements pip install -e .
  5. Set up a conf.py file by copying the conf_example.py file and insert your bot token. You can get your token by creating a discord app, and making it into a bot user.
  6. Within the conf.py file set proper url to access the main server or its proxy.
  7. You are now all set and you can start the bot with python dtat_discord.py

Contributing

  1. If you want to contribute to the main repository please ensure, that your code is following the PEP8 convention. You can do that with the use of flake8 and autopep8, which you can install using pip install -r dev-requirements.txt, after activating your virtual environment.

Bugs & Improvements

If you have found a bug, or you have an idea for new feature please create an issue here on github. You can also contact me using email: [email protected]

Documentation

  1. To generate documentation you will need to install requirements by pip install -e . and pip install sphinx.
  2. Move into the docs directory and use make html
  3. Your documentation is now generated in the docs/build/html directory