Changes between Version 140 and Version 141 of BuildInstructions


Ignore:
Timestamp:
Oct 3, 2011, 10:06:34 PM (13 years ago)
Author:
historic_bruno
Comment:

Updates for premake4

Legend:

Unmodified
Added
Removed
Modified

  • BuildInstructions

    v140 v141  
    1313
    1414== Windows ==
    15 Windows 7, Vista and XP are the main supported versions; 2000 should work too but is rarely tested. Visual C++ 2010 and 2008 are supported. Visual C++ 2005 may also work given a sufficiently modern Platform SDK. Only 32-bit builds are supported (though they can be compiled and run on 64-bit Windows). We have noticed occasional trouble with the free Express Editions; if possible, please consider acquiring the full version (e.g. via university programs). In particular, failures of the built-in self-test test_wdbg_sym.h seem to occur with VC2008 EE but not VC2008 nor VC2010 (c.f. http://trac.wildfiregames.com/ticket/884).
     15Windows 7, Vista and XP are the main supported versions; 2000 should work too but is rarely tested. Visual C++ 2010 and 2008 are supported. Visual C++ 2005 may also work given a sufficiently modern Platform SDK. Only 32-bit builds are supported (though they can be compiled and run on 64-bit Windows). We have noticed occasional trouble with the free Express Editions; if possible, please consider acquiring the full version (e.g. via university programs). In particular, failures of the built-in self-test test_wdbg_sym.h seem to occur with VC2008 EE but not VC2008 nor VC2010 (c.f. #884).
    1616
    1717=== Acquiring the code ===
    … …  
    2828The game must be compiled with Microsoft Visual C++. If you already have Visual C++ 2005 or 2008 installed, make sure you have SP1 and then continue. Otherwise, you can get the free Express edition:
    2929
    30  * [http://www.microsoft.com/express/Downloads/#2008-Visual-CPP Visual C++ 2008 Express Edition] is recommended as project files are currently only generated for 2005/2008 and the upgrade process is not perfect.
    31  * Or download and install [http://www.microsoft.com/express/Downloads/#2010-Visual-CPP Visual C++ 2010 Express Edition]. Pyrogenesis solution will need to be upgraded upon opening and also any time `update-workspaces.bat` is run.
    32 
    33 (If you have the old VC++ 2005 Express, you need to install the separate [http://www.microsoft.com/express/2005/platformsdk/default.aspx Platform SDK] (steps 1-3).)
     30 * [http://www.microsoft.com/express/Downloads/#2010-Visual-CPP Visual C++ 2010 Express Edition] is recommended.
     31 * Or download and install [http://www.microsoft.com/express/Downloads/#2008-Visual-CPP Visual C++ 2008 Express Edition].
     32 * If you have the old VC++ 2005 Express, you need to install the separate [http://www.microsoft.com/express/2005/platformsdk/default.aspx Platform SDK] (steps 1-3).
     33
    3434
    3535The Visual Studio project/solution files are automatically generated from the source files:
    3636
    3737 * Run `build/workspaces/update-workspaces.bat`.
    38  * Open `build/workspaces/vc2008/pyrogenesis.sln`. (If you have VC++ 2005, use the `vc2005` directory instead. If you have VC++ 2010, use `vc2008` and accept the automatic project format upgrade.)
     38 * Open `build/workspaces/vc2010/pyrogenesis.sln`. (Use the `vc2005` directory for VC++ 2005 or the `vc2008` directory for VC++ 2008.)
     39
     40=== Optimised builds ===
     41Make sure to select the "Release" configuration to build an optimised, more playable version of the game (the target will be `pyrogenesis.exe`). The "Debug" configuration can be more useful for debugging but has significantly reduced performance (the target will be `pyrogenesis_dbg.exe`). Both "Release" and "Debug" builds include debug symbols, see [wiki:DebuggingOnWindows Debugging on Windows] for more details on debugging.
    3942
    4043Now you should be able to build the code from within Visual Studio, using "Build Solution" (F7).
     44
     45=== Building Atlas ===
     46If you also wish to test the [wiki:Atlas_User%27s_Guide Atlas Scenario Editor] or [wiki:Actor_Editor Actor Editor] tools, you will need to download and build the [http://www.wxwidgets.org/ wxWidgets] library separately (see `libraries\wxwidgets\README.txt` for details), then supply the `--atlas` option when running `update-workspaces.bat`. Atlas projects will now be included when you open `pyrogenesis.sln` in Visual C++.
    4147
    4248=== Running ===
    … …  
    4450
    4551To run the automated tests, run the "test" project. (Right click on "test" and "set as !StartUp Project" and F5; or right click, "Debug", "Start new instance"). In VS's debug output window, ignore any "first-chance exception" messages; it should say ".......OK!" if it succeeded.
    46 
    47 === Optimised builds ===
    48 By default the project builds in Debug mode, which is helpful for debugging engine problems but is very slow. Change to "Release" in the appropriate dropdown box in the IDE for an optimised build (which will be called `pyrogenesis.exe`).
    4952
    5053=== Keeping up to date ===
    … …  
    152155./update-workspaces.sh -j3
    153156cd gcc
    154 make CONFIG=Release -j3
     157make config=release -j3
    155158}}}
    156159
    157160 * '''-j3''' gives the number of parallel builds to run, and should typically be one plus the number of CPU cores available.
    158  * The '''Release''' mode builds are more optimised, but are harder to debug. Use `CONFIG=Debug` (and run `pyrogenesis_dbg`) if you need better debugging support.
     161 * The '''Release''' mode builds are more optimised, but are harder to debug. Use `config=debug` (and run `pyrogenesis_dbg`) if you need better debugging support.
    159162
    160163If you encounter any build errors, review the [http://trac.wildfiregames.com/report existing bug reports], check the [#Knownproblemsandsolutions known problems section] or please file a [http://trac.wildfiregames.com/newticket new bug in the tracker].
    … …  
    188191./update-workspaces.sh
    189192cd gcc
    190 make CONFIG=Release clean
    191 make CONFIG=Release -j3
     193make config=release clean
     194make config=release -j3
    192195}}}
    193196
    194197If you just edited one source code file and want to rebuild, you can usually get away with:
    195198{{{
    196 make CONFIG=Release -j3
     199make config=release -j3
    197200}}}
    198201
    … …  
    203206./update-workspaces.sh
    204207cd gcc
    205 make CONFIG=Release -j3
    206 }}}
    207 If the `make` line gives errors, you may need to run `make CONFIG=Release clean` before it. If the `update-workspaces.sh` gives errors, you may need to run `clean-workspaces.sh` before it.
     208make config=release -j3
     209}}}
     210If the `make` line gives errors, you may need to run `make config=release clean` before it. If the `update-workspaces.sh` gives errors, you may need to run `clean-workspaces.sh` before it.
    208211
    209212== OS X ==