Changes between Initial Version and Version 1 of BuildInstructions


Ignore:
Timestamp:
Feb 14, 2009, 10:53:02 PM (15 years ago)
Author:
Philip Taylor
Comment:

initial draft

Legend:

Unmodified
Added
Removed
Modified
  • BuildInstructions

    v1 v1  
     1The 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).
     2
     3= General prerequisites =
     4
     5You'll need:
     6 * 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).
     7 * Up-to-date system software (Windows service packs, graphics driver updates, etc).
     8
     9= Windows =
     10
     11Windows XP and Vista are the main supported versions; 2000 and 7 may work too.
     12
     13== Acquiring the code ==
     14
     15The 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:
     16
     17 * 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/svn/ps/trunk/`. This may take a while, and will use around a gigabyte of disk space.
     19 * (See the [TortoiseSVN_Guide TortoiseSVN Guide] page for more details on TortoiseSVN usage.)
     20
     21== Setting up the build environment ==
     22
     23The 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:
     24
     25 * Download and install [http://www.microsoft.com/express/ Visual C++ 2008 Express Edition]. (You can skip the optional Silverlight and SQL Server components.)
     26
     27(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).)
     28
     29The Visual Studio project/solution files are automatically generated using [http://premake.sourceforge.net/ Premake]:
     30
     31 * 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.)
     32 * Open `build/workspaces/vc2008/pyrogenesis.sln`.
     33
     34Now 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`.