Shadowlack

This repository contains data that is specific to the Shadowlack roleplaying game.

Requirements

• Python 3.8
  • virtualenv for making an isolated Python environment. pip install virtualenv
• A database. SQLite3, MariaDB, or PostgreSQL, will work.

Installation

1. git clone --recurse-submodules https://github.com/shadowlack/shadowlack-server.git

2. cd shadowlack-server

3. virtualenv evenv

   Your working directory structure should look like this:

   shadowlack-server/
       evennia/
       evenv/
       shadowlack/
   

4. source evenv/bin/activate (Linux, Mac), or evenv\Scripts\activate (Windows, PS Shell, Git Bash)

5. pip install -e evennia

6. pip install -r requirements.txt

7. cd shadowlack

8. Copy shadowlack/server/conf/.env.example to shadowlack/server/conf/.env and edit your database variables.

9. evennia migrate

10. evennia start

Server Commands

Must be run within the shadowlack directory.

evennia start
evennia reload
evennia stop

Development

Running evennia start for the first time will prompt you to create a new super user account.

Migrations

evennia makemigrations
evennia migrate

Testing

evennia --settings settings.py test commands
evennia test --settings settings.py

Content Seeding

As a super user, run the following commands in the Web Client to seed content. This will seed both the Codex, as well as content flat pages.

batchcode seeder_codex
batchcode seeder_pages

Licenses

The content of this project (characters, species, locations, etc) itself is licensed under the Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license.

The underlying source code used to format and display that content is licensed under a BSD license.

Links 🔗

• Shadowlack
• Evennia Documentation