Installing Chasm

Installing and running a Chasm client

To play, you need to download the client and connect to a server which defines a world.

Installing the client

There are some dependencies so it’s recommended you install everything in a virtual environment (venv).

To install using pip:

$ <activate your venv>
$ pip install -U git+https://github.com/atisharma/chasm
# edit the client.toml file before running the client
$ chasm

You may want to consider using pyenv for complete control over your python version.

Running the client

Check your settings in client.toml, activate your venv and invoke chasm from inside your terminal. So,

$ chasm

will connect to the default server with the character name set in the client.toml config (see the example below). You’ll need to specify a passphrase which will be set as the secret key for your character on the first connection, and to set the port based on which world you want to join. Nobody can play as that character again without the secret key.

name = "Hero"
passphrase = "your sup3r-secr3t un1que pa55phrase"
server = "tcp://chasm.run:port"
loglevel = "warn"

Your character

If you want to override your or any other character’s attributes permanently, create a file characters/Hero.json (if your character’s name is Hero - note the title case). The file should contain json specifying any of the following fields

{
    "name": "Hero",
    "appearance": "Heroic",
    "gender": "Hero's gender",
    "backstory": "Comes from a long line of heroes; heroic from an early age.",
    "voice": "Heroic",
    "traits": "Heroism",
    "likes": "Being heroic, heroic things",
    "dislikes": "Not being heroic",
    "motivation": "To be heroic"
}

reflecting the desired values. Leave out fields and they’ll be automatically generated. The name field is ignored (since it’s implicit in the filename).