Skip to content

Structure

Dylan Plecki edited this page Apr 18, 2014 · 1 revision

The framework is divided into two major components at the root level: the core and all modules.

The Core

The core is used to load the framework and libraries, and to process all of the modules.

As a mission developer, you may not interact directly with the core, as it does it's own work and almost never gets in the way of things.

But you may need to occasionally access core libraries, or files which hold many functions for usage anywhere in the framework. You can access these libraries in the core\libraries folder, and each one is extensively documented for ease-of-use.

Modules

Modules are the building-blocks of the framework; they're the components which interact directly with the user.

Modules are self-contained scripts for executing specific functions, for example loading gear or caching AI. They're individually configurable, and each can be disabled or enabled via two keystokes.

Modules can be found in the modules directory, and a list of them can be edited in the modules.cpp file. Here we include each module individually, so by using the comment feature (//) we can disable modules without having the remove the entire include line.

TODO: Much More.

Clone this wiki locally