2.1 Directory Hierarchy

This section will explain the layout of the directory hierarchy within Crystal Entity Layer.

cel

This is the main directy for Crystal Entity Layer. This can be any path supported by your operating system. This folder also currently contains the configure scripts and Microsoft Visual C++ workspace and project files.

cel/apps

This is where all the applications shipped with Crystal Entity layer reside. Please see the manual section entitled Applications for more information on these.

cel/data

This is where data for the Crystal Entity Layer applications, as well as any applications you build yourself within the Crystal Entity Layer source tree, reside.

cel/docs

This is where the Crystal Entity Layer documentation resides. It is currently available in HTML and TexInfo formats.

cel/include

This is where the header files for the various Crystal Entity Layer modules reside.

cel/include/behaviourlayer

This directory contains the definitions of the Behaviour Layer interfaces.

cel/include/physicallayer

This directory contains the definitions of the Physical Layer interfaces. Including such things as entities, property classes, messaging and persistence.

cel/include/propclass

This directory contains the definitions of the various property class interfaces.

cel/include/tools

This directory contains definitions for interfaces for various utility classes.

cel/mk

This directory includes various makefiles and build configurations for various platforms.

cel/msvc

This directory contains the project files and resource scripts for building under Microsoft Windows using Microsoft Visual C++.

cel/plugins

This is where the implementations of the plugins that make up Crystal Entity Layer reside.

cel/plugins/addons

These are various additional, and optional, Crystal Space plugins.

cel/plugins/addons/celentity

cel/plugins/addons/xmlscript

These plugins allow the loading of Crystal Entity Layer entities from a standard Crystal Space map file.

cel/plugins/behaviourlayer

These are the various behaviour layers which have been already implemented for use with Crystal Entity Layer.

cel/plugins/behaviourlayer/python

This is a behaviour layer that allows entity behaviours to be implemented using the Python scripting language.

cel/plugins/behaviourlayer/test

This is the test behaviourlayer implemented in C++.

cel/plugins/behaviourlayer/xml

This is a behaviour layer that allows entity behavours to be implemented using scripts stored as XML.

cel/plugins/persist

These are the various persistence layers which have already been implemented for use with Crystal Entity Layer.

cel/plugins/persist/classic

This is the Crystal Entity Layer Classic Persistence Module. This allows the persisting of Crystal Entity Layer entities to a Crystal Space VFS file.

cel/plugins/propclass

These are the various property classes which have already been implemented for use with Crystal Entity Layer. For more information on these please see the section entitled Property Classes

cel/plugins/stdphyslayer

This is the Crystal Entity Layer's Standard Physical Layer.

cel/scripts

This is where scripts used by the Crystal Entity Layer applications and examples reside.

This document was generated using texi2html 1.76.