Changes between Version 9 and Version 10 of BuildInstructions


Ignore:
Timestamp:
Jun 23, 2009, 6:05:15 PM (15 years ago)
Author:
Philip Taylor
Comment:

update Windows build instructions

Legend:

Unmodified
Added
Removed
Modified

  • BuildInstructions

    v9 v10  
    1 The current release of the game is aimed at developers and not at 'normal' users. As such, the following instructions assume a reasonable level of technical proficiency. If you encounter difficulties, please post on the forum (TODO: add a link to the right forum).
     1[[TOC]]
    22
    3 = General prerequisites =
     3The current release of the game is aimed at developers and not at 'normal' users. As such, the following instructions assume a reasonable level of technical proficiency. If you encounter difficulties, please post on the [http://www.wildfiregames.com/forum/index.php?showforum=312 forum].
     4
     5== General prerequisites ==
    46
    57You'll need:
    68 * An adequately high-spec computer - several gigabytes of free disk space, preferably at least 1GB of RAM for compiling, a fast CPU unless you want to spend ages waiting for the compiler, etc. Modern graphics hardware is also recommended, though the game can run (slowly) on fairly old devices (!GeForce 4, Intel 945GM, etc).
    79 * Up-to-date system software (Windows service packs, graphics driver updates, etc).
     10 * Some technical proficiency. We try to make the build process as smooth and painless as possible, but it's designed to be followed by programmers - if you just want to play the game, wait for a pre-packaged installer instead.
    811
    9 = Windows =
     12== Windows ==
    1013
    1114Windows XP and Vista are the main supported versions; 2000 and 7 may work too.
    1215
    13 == Acquiring the code ==
     16=== Acquiring the code ===
    1417
    1518The game's code, data and build environment are stored on a Subversion server. The recommended way to get an up-to-date copy is with TortoiseSVN:
    1619
    1720 * Download and install [http://tortoisesvn.net/ TortoiseSVN]. (Make sure you reboot when it asks you to.)
    18  * Use TortoiseSVN to check out `http://svn.wildfiregames.com/public/ps/trunk/`. This may take a while, and will use around a gigabyte of disk space.
    19  * (This is the read-only public SVN URL. If you have commit access, you need to use `http://svn.wildfiregames.com/svn/ps/trunk/` instead.)
    20  * (See the [TortoiseSVN_Guide TortoiseSVN Guide] page for more details on TortoiseSVN usage.)
     21 * Use TortoiseSVN to check out `http://svn.wildfiregames.com/public/ps/trunk/`. This may take a while, and will use around 700MB of disk space.
    2122
    22 == Setting up the build environment ==
     23(This is the read-only public SVN URL. If you have commit access, you need to use `http://svn.wildfiregames.com/svn/ps/trunk/` instead.)
    2324
    24 The 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 skip this section. Otherwise, you can get the free Express edition:
     25The [http://tortoisesvn.net/docs/release/TortoiseSVN_en/index.html TortoiseSVN manual] has information on [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-checkout.html checking out], as well as [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-update.html updating] and [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-patch.html creating patches].
     26
     27=== Setting up the build environment ===
     28
     29The 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:
    2530
    2631 * Download and install [http://www.microsoft.com/express/ Visual C++ 2008 Express Edition]. (You can skip the optional Silverlight and SQL Server components.)
    … …  
    3035The Visual Studio project/solution files are automatically generated using [http://premake.sourceforge.net/ Premake]:
    3136
    32  * Run `build/workspaces/update-workspaces.bat`. (You'll have to repeat this step each time a source file is added or removed from the code.)
    33  * Open `build/workspaces/vc2008/pyrogenesis.sln`.
     37 * Run `build/workspaces/update-workspaces.bat`.
     38 * Open `build/workspaces/vc2008/pyrogenesis.sln`. (If you have VC++ 2005, use the `vc2005` directory instead.)
    3439
    35 Now you should be able to build the code from within Visual Studio, and it probably should work without any errors. Run the game with F5 inside Visual Studio. If you want to run it outside the debugger, run `binaries/system/pyrogenesis_dbg.exe`.
     40Now you should be able to build the code from within Visual Studio, using "Build Solution" (F7).
    3641
    37 = Linux, OS X =
     42=== Running ===
     43
     44Run the game with F5 inside Visual Studio (assuming "pyrogenesis" is set as the startup project, which is default). If you want to run it outside the debugger, run `binaries/system/pyrogenesis_dbg.exe`.
     45
     46To run the (currently quite minimal) 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.
     47
     48=== Keeping up to date ===
     49
     50After you've set everything up, the process for staying up to date is:
     51 * [http://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-update.html Update] the root directory of the checkout.
     52 * Close the solution in Visual Studio if you've got it open. Run `update-workspaces.bat` again. (This is only needed if any source files have been added or removed. If you forget to run this, you'll probably get build errors about missing symbols.)
     53 * Build again.
     54
     55== Linux, OS X ==
    3856
    3957This is much less streamlined than the process for Windows. But you're cooler than a Windows developer, so you should be able to cope.