Skip to content

henriklindstrom/lime-mud

Repository files navigation

Lime MUD

Awesomeness in a package

What this plugin does

Describe what this plugin does here...

Developing

Setting up your environment

Windows

Setting up a virtual environment:

C:\my-plugin>C:\Python34\python -m venv venv
C:\my-plugin>venv\scripts\activate
C:\my-plugin>pip install -r requirements_dev.txt

Linux

The development environment is based on docker.

To build the docker image, run:

$ make build

Running tests

Windows

C:\my-plugin>python manage.py test

Linux

$ make test

See what other commands are available

Windows

C:my-plugin>python manage.py -h

Linux

$ make help

Configuration

To add default configuration options to this plugin, add them to lime-mud/lime_mud/init.py like so:

def default_config():
    return {
        'my-option': 'its default value'
    }

These options can later be retrieved like this:

import lime_config

def my_function():
    opt = lime_config.config.plugins['lime-mud']['my-option']