dndserver

(β˜… 275)

Dark and Darker private server implementation written in Python

  • .dockerignore
  • .gitignore
  • .pre-commit-config.yaml
  • alembic.ini
  • config.example.yml
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • poetry.lock
  • pyproject.toml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/Snaacky/dndserver

Downloads the entire project code from GitHub to your computer.

cd dndserver

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
$ wget https://raw.githubusercontent.com/Snaacky/dndserver/master/docker-compose.yml

Runs the command against the services defined in the compose file.

$ docker-compose up -d

Runs the command against the services defined in the compose file.

$ docker exec -it dndserver alembic upgrade head

Type this command into your terminal and run it.

$ docker restart dndserver

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ poetry install

Installs the libraries listed in pyproject.toml.

$ poetry shell

Type this command into your terminal and run it.

$ python -m dndserver.server

Runs the Python script (or module).

python -m jurigged -v .\dndserver\server.py

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation