Build directory

This article is for reference purpose.

The features described in this article are already implemented in the engine. The article should describe how a certain aspect of the engine currently works. Your opinions or improvement suggestions about the described aspects are of course appreciated. But please put them on the discussion page of this article.

Introduction

This is a proposal how the trunk/build directory should look like. That doesn't mean that all mentioned files would need to be stored in SVN. The SVN repository is the best place for project files that are often updated; library and software packages to compile FIFE should be distributed as seperate compile SDKs. This article merges these two different things together so this is how the trunk/build directory would look like after all compile SDKs would have been installed

Structure

Linux

Platform-dependent information: Linux.

The following passage contains information that is specific to Linux and other POSIX-based operating systems.

• trunk
  • build
    • linux

Mac

Platform-dependent information: Mac.

The following passage contains information that is specific to PPC and Intel-x86-based Macintosh systems.

• trunk
  • build
    • mac

Win32

Platform-dependent information: Win32.

The following passage contains information that is specific to Windows operating systems.

MinGW

• trunk
  • build
    • win32
      • mingw
        • applications: Location where tools that are needed for the compile process are stored.
          • mingw: The MinGW compiler.
          • scons: The SCons build environment.
        • bin: Dynamic link libraries that are required to use FIFE under win32 should go into this folder. The user would copy the content of this folder into trunk.
        • include: All third party library headers are stored here.
        • static_libs: Static link libraries of third party libraries that FIFE uses are stored here.
        • build_engine.bat: Batch file to build the engine.
        • cleanup_engine.bat: Batch file to cleanup the files that have been created in a former build process.
        • logbuild_engine.bat: Batch file to build the engine and log the build process (engine_build_log.txt)

MSVC 2005

• trunk
  • build
    • win32
      • msvc2005
        • applications: Location where tools that are needed for the compile process are stored.
          • scons: The SCons build environment.
        • bin: Dynamic link libraries that are required to use FIFE under win32 should go into this folder. The user would copy the content of this folder into trunk.
        • include: All third party library headers are stored here.
        • static_libs: Static link libraries of third party libraries that FIFE uses are stored here.
        • fife.vcproj: MSVC (sub-)project file to build libfife.lib. Can be automatically created with scons by executing update_msvc_project.bat.
        • fife_engine.sln: MSVC solution file to build the whole project; that means libfife.lib and fife_engine.exe.
        • fife_engine.vcproj: MSVC (sub-)project file to build fife_engine.exe. Can be automatically created with scons by executing update_msvc_project.bat.
        • fifeproj_template.xml: XML template that is used to create fife.vcproj by running update_msvc_project.bat.
        • update_msvc_project.bat: Batch file to create an up to date fife.vcproj with the help of SCons.