2.1 Directory Hierarchy

This section is intended to explain the general FR directory structure. It contains all directories, so maybe some will be missing, if you just downloaded the files for a specific port like Linux or Win32.

FreeRaider consists of the following directories:

FR

The main directory for FreeRaider. You can choose any path for it, as long as it is supported by your operating system. This is the path that all compiled programs end up in. This should be your working directory for these executables. On Windows you need to copy the FR directory to the `CS/apps' directory.

FR/apps

This is where all applications which ship with FreeRaider reside.

FR/apps/tests

Applications for testing specific features of the project reside here.

FR/bin

Some scripts to support the build process on various platforms.

FR/doc

The root of the FreeRaider documentation hierarchy. There are several subdirectories.

FR/doc/texinfo

Texinfo is the master format for all FreeRaider documentation. This directory and its subdirectories contain all of the Texinfo source and images which comprise the FreeRaider manual. Most users need not concern themselves with this directory since the Texinfo documentation is automatically converted to HTML which is more accessible to the general user. Documentation writers and maintainers may be interested in this directory.

FR/doc/html

This directory contains the HTML conversion of the Texinfo FreeRaider documentation. Most users will want to look at `FR/docs/html/index.htm' which resides here.

FR/doc/incoming

This is a temporary staging area for documentation which has not yet been converted to Texinfo format. Much of this documentation is useful and worth perusing.

FR/doc/pubapi

This directory contains the FreeRaider SDK's public API reference manual rendered into HTML format.

FR/apps/freeraider/include

Here are the headers that can be used from other modules.

FR/apps/freeraider/libs

Here are all Modules provided be FreeRaider. Some modules will consist of only one subdirectory in libs, some will be a combination of several subdirectories.

FR/apps/freeraider/libs/frutil

This library contains various utilities.

FR/apps/freeraider/libs/frplayer

This library contains a class for saving and loading a player database.

FR/apps/freeraider/libs/frnet

Some commonly used net functions

FR/apps/freeraider/plugins

Plug-in, dynamically loaded modules. Communication with these modules is performed strictly via SCF interfaces.

-- explain subdirs in plugin --