The official Python Daemon of Cryptic

The documentation can be found on GitHub Pages.

If you want to build the documentation yourself, use the docs script:

pipenv run docs

• Python >=3.9
• Pipenv
• Black
• Git
• Docker (recommended)
• PyCharm Community/Professional (recommended)
• An instance of the Cryptic Java Server

Once you have cloned the repository, you need to create a virtual environment and install the dependencies using the following command:

pipenv sync --dev

Create a file named (exactly) .env in the root directory of this repository with this content:

# API_TOKEN=
DEBUG=1
HOST=127.0.0.1
SQL_SERVER_LOCATION=postgresql://172.17.0.1:5432
SQL_SERVER_DATABASE=cryptic
SQL_SERVER_USERNAME=cryptic
SQL_SERVER_PASSWORD=cryptic
SQL_SHOW_STATEMENTS=1
SQL_CREATE_TABLES=1
# SENTRY_DSN=

You will need to adjust these environment variables according to the documentation.

To run the Python Daemon yourself, use the daemon script:

pipenv run daemon

Before committing your changes, please reformat your code using black:

black -l 120 .