Home

Deuterium's documentation is in a state of heavy flux pre-release. Things may get added, removed or drastically reorganized.

Welcome to Deuterium's documentation. Here you'll find information on how to add space-based functionality to your own game using our libraries, allowing you to focus more on the content of your game and less on how to make it happen. If what we've made is lacking for your requirements, don't worry -- you'll find out where to go to extend Deuterium to make it do what you need.

Getting Started

Getting started with Dueterium is easy (especially compared with getting started with hSpace, its inspiration). All of its components are independent of Evennia's core, so you can update your game around it without worrying about any compatibility issues.

Import Deuterium

Copy each folder in contrib/deuterium into the corresponding folder within game/gamesrc within your Evennia installation. This makes Deuterium classes available to be loaded.

Prepare Database

Next, run a manage.py, followed by manage.py migrate. This should load Cochran's typeclasses and command sets in. You may additionally have to evennia.py -i stop and evennia.py -i start.

Now you should have a basic installation of Evennia running with Deuterium on it.