Directory Structure Overview

From LagoonWiki

Jump to: navigation, search
  • gyarados - root directory
    • bin - compiled executables and libraries
      • old nebula tcl utility scripts - unused
      • $os[d]? - directories for various compiled versions (d -> debug mode)
        • linuxd - what we use
    • code - all code (-tcl)
      • .mak -> makefiles included by the generated makefile
        • defines.make -> definition of included libraries / directories
      • inc - .h - c++ headers
        • code is organized into various directories forming a loose categorization
        • updsrc.tcl - script which generates src/nebula.mak - automatically called by make when the .pak files change
      • src - .cc files - c++ code
        • nebula.mak - generated makefile containing all dependencies
        • duplicates of the directories in inc -> only these include .cc and .o files
          • $classname_main.cc - regular .cc code for the class
          • $classname_cmds.cc - c++ code to allow integration with scripting system
      • scripts - .py files - python code
      • pak - .pak files -> abstract makefiles, from which src/nebula.mak is generated by code/updsrc.tcl.
      • templates
        • classbuilder.tcl - script for generating new c++ classes
        • classtemplates.tcl - template for new .h .cc files
      • vstudio - generated vstudio project files for compiling on windows
    • data - data files
      • subdirectories are various projects, which can be loaded by the FileManager
    • doc - documentation
    • externalPackages - contains various external packages we link / use -- saves people from having to download / install them
    • lib - precompiled library files
Personal tools