Rule Writers Guide

Introduction

This document is (will be) a guide to extending existing rulesets (games) for indri, or creating completely new rules.

Pre-requisites

It is assumed the reader has a basic understanding of Atlas; while indri takes care of many aspects of Atlas for rule developers, it still affects many other areas. For a good initial introduction, see the Acorn Internals paper, or Demitar's documents

Operations

Create operations using the basic constructor for the class, or by using a helper 'factory' function, many of which are defined in 'operations.js'. If using the plain constructor, the syntax is as follows:

typeThe basic Atlas type of the operation, as a string. (Potentially support type objects here in the future)
fromThe origin entity for the operation. This can take various forms : an Entity object, an EntityId, a string-ified EntityId, or just null.
toThe destination entity for the operation. As above, various kinds of value are permitted.
Each successive argument to the Operation constructor is treated as an object to be added to the Atlas arguments array.