AftGangAglay Documentation

Configuration File

The project configuration file (aga.sgml by default) is written using SGML with a very simple DTD. This means the configs resemble a highly simplified version of XML.

A sample document might look like this: 

<root>
	<item name="Category">
		<item name="Option1" type="String">
			Hello, world!
		</item>
		<item name="Option2" type="Float">
			0.23f
		</item>
		<item name="Option3" type="Integer">
			42
		</item>
	</item>
</root>
In documentation, Option1 here would be referred to as Category.Option1.

Applications can access this configuration through the getconf function, and thus it can and should be used for storing all application-specific configuration alongside the built-in options.

Built-In Options

There are several options which AftGangAglay directly references from this file. These compose project configuration and are generally how the engine is informed of how to run your executable. These are detailed below:

Key Type Default Description
General 
   General.Version
 String Executing engine version The version of the engine the project is written for. This should be updated by the application maintainer alongside engine updates if neccesary.
Display 
   Display.Width
 Integer 640 The width of the main application window. 
   Display.Height
 Integer 480 The height of the main application window. 
   Display.FOV
 Float 90.0f The FOV to use when creating perspective projection matrices.
Script 
   Script.Startup
 String script/main.py The relative path to the main startup script for the application. 
   Script.Path
 String script The list of search paths for Python modules, separated by :.
Development 
   Development.PreHook
 String A command to be executed on startup when using a debug build of the engine. This is not enabled in release builds to avoid unintentional errors/executions when in distribution.