Mingw compilation

This page explains how to compile Globulation 2 on windows using mingw.

Installing required software for tutorial

Setting up Python, Scons, Mercurial, and NSIS

NOTE: For Windows VISTA and above Users: You need to run as an administrator to install those packages, The Msi installer are perfect , some other got to have warnings some because no Valid or missing The Digital windows OS certificate (Xp, Vista,7 :logo ) accept to install it anyways, and another may ask for an authorization to install some other dependence files , do accept. For some "setup.exe" you might need to run them as administrator by right-clicking on it and select run as an administrators (specially for scons & MinGW)

• Download Python EXCLUSIVELY A PYTHON V2.x.x VERSION -Newer Python are not compatible with scons (V1.x.x or V2.0.0.final.0)
• Install into the directory "C:\Python26" (default install is Python_version_number, change this number to 26 during installation if you want to avoid a BUG [Issue #3], even if you got Python34 )! the Version 3.1.2 is NOT COMPATIBLE as I'm writing now (july-2010) !
• Download scons-1.1.0 and install it [**AS ADMINISTRATOR**] into the same directory as the python install (C:\Python26\) If you are installing the most recent scons version than the "scons-1.1.0" An issue #3 [BUG] will occurred. An easy measure is not yet defined. The Version 2 has been tested and is compatible with Python27 but not with Python31 nevertheless using other version than the v1.1.0 will call the issue #3!
• Download and install mercurial, Mercurial-1.6.0 stable without TortoiseHg. For the futur (When the link above will be broken) you can check this area:other download link to get mercurial.The old Mercurial data References for this Wiki could be found there (Outdated-support).PLEASE INSTALL ONLY ONE Mercurial ! The Mercurial version 1.6.0 with Tortoise or not work perfectly !

• What About TortoiseHg, though ?

TortoiseHg is a set of graphical tools and a shell extension for the Mercurial distributed revision control system. On Windows, TortoiseHg consists of a shell extension, which provides overlay icons and context menus in your file explorer, and a command line program named hgtk.exe which can launch the TortoiseHg tools. Binary packages of TortoiseHg for Windows come with Mercurial and a merge tool and are thus completely ready for use “Out of the Box”.

It's a powerful GUI interfaces for developer, and give to the simple user an overview easiest and simplest ever ! Even better than Globulation2 Hg Web site, in my opinion, I just love it. After Testing, No trouble has been noticed and you can continue to use Minimalist Gnu for Windows and Hg command line to perform it by hand like this tutorial teach you to do. Soon we will use this powerful GUI for even less command lines ! :)

Wanna Know more about TortoiseHg visit their Web Site here, please.

OPTIONAL DOWNLOAD:

(To create a windows installer)

• Download and install NSIS into all its default installation folder "C:\Program Files\NSIS\".

(To be proud of using MS WINDOWS GUI for tarballing archives matter)

• Look for7-Zip (GNU) or winrar (winrar is a Commercial Shareware -with a 30day free-trial), You have also IZarc [Free](but it can't make Gzip archive, he does extract them However) for a more friendly GUI than command line, We are under Windows, do we ?

(In case of Bug or Issues, who knows ? )

• Look for notepadd++ (free gnu software) to edit code lines (specially for scons).

Setting up MinGW and MSYS

• Download MinGW- Minimalist GNU for Windows (the actual v5.x.x works well)and
• Install it into the directory c:\mingw (lower case).
• During installation, select "Current" when asked what version, and then
• select the "MinGW base tools" (by default) and "g++ compiler" packages only
• Download and install MSYS-1.0.10.exe into the directory c:\msys\1.0\ (lower case).
• At the end of the installation, it will ask you if you want to continue with the post-install. Select yes, and yes again when it ask if you have mingw installed.
• Then -the black windows prompt- will continue asking you to indicate where the directory is installed,type :
• c:/mingw (yes, with a forward slash -linux habit to have- as the program prefers it that way).

Compiling Prerequisites

• Open in a news Windows Explorer windows the path "C:\msys\1.0" (we will drop some files into it later from an archive)
• Download glob2_required_libs_mingw-scons.tar.bz2 and put it in the home directory of msys (c:\msys\1.0\home\XXX\ where XXX is the username)
• Open it with a bz2-tar archiver application like Winrar,or 7z, and
• Drag and drop All Directories from the Archivers (e.g Winrar) into the path "C:\msys\1.0" (remember we already got a windows ready for that) , tell yes if it ask for over writting, or already existing files/folders. This could take a While.

NOTE: On Windows VISTA and Above you might need the Administrators Right to access copy or drag and drop files into the C Drive trees. an inheritance from linux chmod :(

ONCE Done, close the Archiver, and Windows that we opened for the drag and drop.

OLD_METHODE , 'command line geek' -This will be cleared soon- :

• Double click the MSYS icon that has been placed on your desktop during MSYS's installation.
• Go in the directory where you put the glob2_required_libs_mingw-scons.tar.bz2 (for example cd ~) and untar the libraries using the command below. This process could take a while:

tar jxf glob2_required_libs_mingw-scons.tar.bz2 -C /

ON The Way to get Ready for Compiling Globulation 2

Step 1: Choosing from What Source Code to compile

INFO: 'Mercurial source' is a well known expression but at my sens are an Idiom abuse, What People called here mercurial Sources,is designing in reality the Globulation Source Development Pool using Mercurial, and that is the way I would prefer to name it "Project source files".Mercurial is indeed a Sotfware who organized the Globulation project development and not The project name itself, but I will sometime refer to "mercurial sources" idiom inside this wiki, since this is a pretty common well-known-expression.

Follow the

• step 1A for compilation with Official Code source release (tar-ball download)
• step 1B for compilation from 'Mercurial source' by hand -friendless-
• step 1C for compilation from 'Mercurial source' by Friendly windows :D

Follow only one of those step and after done it , got to go to the appropriate STEP2

STEP1 A - Official Web site Released source code

• Download [ Download_and_Install ] The c++ tarball archive source code file
• Create a Folder name "glob2_source_building" at c:\msys\1.0\home\XXX\ (where XXX is the username)
• Extract the source code archive [USING 7-Zip or assimilated software]in the folder you have just made.
• Then Go Down to STEP2 ( quicker compiling way :)

STEP1 B - The "Project source files" [NO TURTOISE API]

(known formerly as Mercurial Source)

Hint: If you got the TortoiseHG (is friendly Windows software appearance using Mercurial ) you can USE IT, by going down now to the B.2 Section!

• Download Globulation 2 from a remote repository (Formerly called here mercurial-Sources.

hg clone http://hg.globulation2.org/glob2-new glob2-local-repository

This can take a while if your internet connexion is a limited bandwidth, You are "just" getting ALL the Globulation Work history back from November 2001, when it all began ;)

Do you look for more information about hg clone option&parameters see this MAN PAGE.

DESCRIPTION:

• Tags Tags are used to name particular revisions of the repository and are very useful to compare different revisions, to go back to significant earlier versions or to mark branch points as releases, mark certain versions when glob2 publishes a new released (e.g beta4.5 is the beta-4 series 5th version ). This is better and more stable than the beta4.4 but should not desync against beta4.1. If you only want to play glob2 beta4, use the latest tag beta4.whatever_revision.

• tip is a special Revision tag. It is the revision last committed to the Working repository. In general this is not what you want but you get it by default.

• Branches are a kind of core-game or working-pool which is based on an existing release ( game source_code) so branches are set to define some news BIG changes or features like 'replay' or 'market_bug' or why not AI_changes ,They are used to mark a sequence of revisions that are not necessarily all stable. Somewhere between beta4-rc branch and beta4.5 there might be versions -branches with Revision update applied or not- that don't compile (mainly for Coding mistake or incompatible branch modification with the apply of an Revision (patch for other bug or merged branches) or not. If you want to help on a beta4.6 you would need to get the branch beta4-rc and update with the revision you would like to help for in this case beta4.6 -this will be explain later.If you would like to play the Beta4.5 with the latest patch (who may be unstable too) you will need to extract the Branch "beta4-rc" and later update it with a proper tags like "tip" or "beta4.5" or else(you got the tags list from the command 'hg tags').

• default is the main branch where the latest changes is being made (New Series Version,New RC, or unstable version, so this might include new branch). IT's the right place to check it out what news stuff is being coded and implemented.

• NOTE:If you would to play this branch is not the right -could be Desynchronized , and Unstable.If you look for fixing bugs, this is not the right 'setting' either, because you might look for the buggiest version. Bugs in the default could got fixed in the earliest supported branches (those with an -rc) but not always.If you want to implement new features that you are sure to finish do it in "default". If your feature is complex, use "default" but branch off a feature branch (hg branch my-complex-feature)-> the branch creation will not exist in the repository until the next commit -see HG MAN page for references.

• Now time for Extracting The [branch name you picked above (this depending of your goal)] you want to work/play with from the 'Project source pool called mercurial' download into the a separate folder for the updating & compilation work, I decided to named it "glob2_source_building". So if the compilation abort you do not have to download again from the remote site the mercurial data, avoiding a server overload.In a case of a compilation failure and ONLY in this case you should just delete glob2_source_building by using Windows explorer GUI (with contextual menu and mouse use) This folder should be found at "C:\msys\1.0\home\XXX" Where XXX is your PC's name or username.After that start over from down here.

hg clone -r [branch name you picked above e.g beta5-rc] glob2-local-repository glob2_source_building
cd glob2_source_building

Hg clone HELP here.

• update to the Revision you would like to apply, have or work with.

The [OPTION] -C will assure you that no Hybrid code will be made by any merge branching uncommitted 'revision'. if the update tag chosen is an no consequent one like you choose to apply a Revision design for Beta3-series on your chosen branch beta5-rc , The updater will abort with no modification -If I correctly get the meaning in the manual see: Hg manual. Hint: Branch name could be alias as 'Feature-pool' and tag as 'Revision' ,both are proper called 'changeset' in the Hg manual.

hg update -C [tag 'revision' name you'd like to have e.g tip or beta4.5 ]

Hints: The list of tags are listed with the command "hg tags"

To get more information about How Mercurial Work have look there :Mercurial.

STEP1 C - The "Project source files" [USING TURTOISE API]

(known formerly as Mercurial Source)

WARNINGS: THIS SECTION IS EXPERIMENTAL AND UNDER CONSTRUCTION TESTING!

• DOWNLOADING the 'Project'

• Open Windows File Explorer (WIN_KEY+E) and go to "C:\msys\1.0\"
• Create a Directory Call "glob-compilation", Get inside this folder
• Right clicking, This open the contextual menu, then
• select TortoiseHG>>Clone ,a pop-up windows will appear,
• in source path please fill in this: "http://hg.globulation2.org/glob2-new" without the quotation mark.
• as Destination fill it that way: "C:\msys\1.0\glob-compilation\repository\" without the quotation mark.
• push the button "Clone"

This Will take a lot of CPU energy and internet bandwidth, internet broadband is recommanded (size is over 100MB)!

• SELECTING Branch

• Right-click on the repository folder, mouse down -in the contextual menu- to "Hg Repository Explorer", this open the Explorer where you can see and get an overview of all the sources modification from the very beginning of the project up to now ( at least the download date or update of the online-repository !

Now Here you can see The project source board is a bit complicated to explain all things though , I will limited myself to the basic staff, feel free to read the Software HELP. Now let 's get the list of those branches,On the middle under the task-bar of Turtoise, you can see a kind of button following by an arrow called "branches" if you click on the by-next arrow you can see a list of the actual branches in the repository you are actually exploring.

• Branch Definition

• Story

(you can skip it if you don't care about How the code is organized)

Branches are like a small-working-pool which is based on an existing release ( game source_code) so branches are set to define some news BIG changes or features like 'replay' or 'market_bug' or why not AI_changes ,They are used to mark a sequence of revisions that are not necessarily all stable, they come from parent and lead to children unless if the got merge in or off. Why this definition is important for you? Because you need to choose a branch, remember a (small-working-pool), where you will put some -if available- Patch or Revision , called also Tags. So your job is to choose the branch for YOUR NEED ! What needs ? Well Do you compile under-windows just for the fun ? Of course not, its because the Binary (Glob2.exe) is not yet release and downloadable, you know , The game version fixing the Last Horrible Bug ,that all Linux-user already get free of (because some linux-distros community are more reactive than under windows for this game-binary) ! Now we can Get ride of those Bug too, as they do, or get some news also as they do, using the common Project source pool orgazined with the Mercury sytem, than we use trough Turtoise! Because apart from some Stable Game Code, who is released long ago on unix system prior to Windows, that is why you are here to compile your own Binary from the lastest stable Code that the Unix community use, or even to see the latest cool staff the devs have just implemented with their new bug too :( All the "cooking" could lead to a compile failure, or a more instable game-client , YoU know it ,you tried to apply a patch fixing one things ,but a news Big Bug appear, who is more annoying than the first one ! So way to speak the Decision belong to you !

• SUMMARY , capital information

The 'Default' is the last one where every one look at for improvement.not necessary stable. after come the 'betaX-rc' who the X represent the Game Core Version along with the suffix -rc , meaning Release Candidate are usualy stable and less buggy, good for gaming ! And the other are mostly dedicated for debugger, tester, and other geeks!

• CLONYING our Branch

(for a clean Re-compilation in case of Failure )

• Create a Directory called "glob2_source_building" -with Windows File Explorer (WIN_KEY+E)- at "C:\msys\1.0\glob-compilation\"
• Right clicking on this new folder, will open the contextual menu, then
• select TortoiseHG>>Clone ,a pop-up windows will appear,
• Set the source path to the " repository" folder either using the Browse button or filling up the field with "C:\msys\1.0\glob-compilation\repository"
• Select using the arrow the "advanced options"
• Check the box "clone to Revision" and in the next field, fill in the branch you want. ( e.g: Default ,or, beta5-rc ).
• launch the clonning process by pressing the button. ( this time it's require less time)

• UPDATING IT

This stage , in my opinion as I am writing, is optional, the purpose is to get the last Revision that has been coded for our branch, they are called Tags, Revision, Changesets, or patch. When using a stable version most likely your branch is an -rc one, the update is not very needed, expect if you want to apply a patch who is reputed to work well with no side-effect.

If you update to an "Revision",who is buggy or old, you could create some version who is really not WANTED, because of the bug they can create and the hight risk of compilation failures.To prevent this check the box , "discard local changes,nobackup -C/--clean" option, and always show log ( to get a traceback of any change that will be done). USING the -C option will avoid any bad update ! it's a safe way to update, I think.

I'm not really confident with updating, but some do , with no trouble. The Tags, or "Revison"; tip is really adapted to the default branch, for a good 'cooking' ask the devs or look upon the forum to see what update Revision to use with what Branch.

On the Update setting windows you can choose your Tags, and see the target description below , who will change for each different one. The parent part will inform you about the actual branch you are updating from.

• Right clicking on the glob2_source_building folder, This open the contextual menu, then
• select TortoiseHG>>update ,a pop-up windows will appear,
• choose your Revision you decided to apply (e.g: tip)
• check the first and third options
• then push the update button

Once done, close the windows.

Now time for compiling, and we need to get ready for command lines....

STEP 2: COMPILATION

PLEASE NOTE: The compilation Stage could lead to some ISSUES,they are disccuss in the proper section below. Don't worry about the warnings while compiling. If something is wrong, it will grind to a halt and it will let you know why.Also Depending on the machine characteristic the process could take more or less longer. from 5min from a rocker computer to I guess over 192 mins for a old and tired computer

When You have Followed the

• STEP 1A follow the STEP2 A&B
• STEP 1B follow the STEP2 A&B
• STEP 1C follow the STEP 2C

Pretty easy , right....

Step 2 A&B Direction

• Start compiling Globulation 2.
• Open msys by double clicking the desktop icon, type the following code into the emulated *NIX-shell;

cd glob2_source_building 
scons

• Known-issue (this section could be move to fill up the ISSUE SECTION at the end of the Wiki):

• Related to ISSUE #3.1

YOU NEED to have installed as an Administrator "scons-1.1.0" this exact version IF not the Issue#3 will occur [Error should be like :

"../bin/scons", line 7, in <module>
import SCons.Script
ImportError: No module named SCons.Script

and then a painful debugging process will be engage :(

• Related to ISSUE #3.2

Also the Python SHOULD BE a V2.x.x release not The V3.x.x.x who break compatibility with scons !

Error code will like :

File "c:\Python26\Lib\site-packages\scons-2.0.0.final.0\SCons\__init__.py", line 43, <in module>
import SCons.compat
ImportError: No module named SCons.compat
(same things with) _scons_builtins

The Python Website -official- clearly show that even the __init__.py file, line 42 !

• Once compiling has finished
• Make a 'TEST' directory call "test" or "whatever" using MS WINDOWS in your desktop or 'elsewhere' for the simplest example we will set it up in our windows desktop :) .
• Copy into it all the file found in "C:\msys\1.0\local\lib" then do not forget to do,
• Copy and past of the Glob2.exe from "C:\msys\1.0\home\XXX\glob2_source_building\src\" where XXX is the PC's name or user into this 'Test' directory you have made in your desktop.
• Copy the SDL.dll from "C:\msys\1.0\local\bin" and past it into your desktop 'test' folder, and...
• launch it ! ENJOY IT !

At first start the application, the game, is freezing , because it is setting many parameters, so on a slow/busy machine this could take a while.

Another old_school Method for testing ( Did not work on Windows, at least mine :( !

-Once compiling has finished, run (if you 'r ,kamikaze, the following to prepare Globulation 2 for testing:

cp -a /local/bin/SDL.dll /local/lib/*.dll .
cp -a ./src/glob2.exe .

-Run glob2.exe from the glob2_source_building directory and play :) [this stage too might lead to lack of dll,bond ! who said that command line are better ....

Building a Globulation 2 NSIS installer

• In MSYS, run the following codes to compile a windows installable exe file:

cd glob2_source_building
cd windows
glob2_make_win32.sh

• If all things go well, an exe ready for installation on windows computers is now ready within the windows folder. Test it (install and play), and if it works, send it to your friends ;)

Possible Issues

ISSUE #1.

Make sure you have no hidden GNU-GCC installed somewhere. GCC is for example included in the FreePascal-Compiler. (You won't find any Lib anymore if another GCC is activ.)

ISSUE #2.

Make sure path to GCC is set in Path Enviroment Variable. The Scons-Script just aborts (can't find libSDL) if it is not.

ISSUE #3. sh: /bin/scons: No such file or directory

(Wrote in Summer-2010)

• Fixed that by installing Python2.6 along with scons-1.1.0 or editing scons file found in the ../Bin/ more details about that below.

I got this trouble as many other people (http://globulation2.org/forums/viewtopic.php?t=210). It is not quite easy to explain how to make-it-works,The solution could be fixed easily but have to be dynamic with ever new python & scons product version . So this Trouble could come over again later.

• Where that Trouble come from ?

This comes from a "linux-kind-link" who has been designed for Python 2.6 AND scons-1.1.0 Versions, Guess what this link is (OUT TO DATE) due to the fact that the Python today version and scons have evolve their name, their path could too ! That said, as you see The Trouble will come over and over if the way to bond the scoms path to the mingw sh (linux command bash, & emulated environment) will stay like that.

• What the Community could do ?

Here some ideas: We might need to keep up-to-date either this Wiki page and the scoms file provided in the tarball file call 'Prerequisites' (http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2). Yes, telling people what Python & scoms version STRICTLY to use and keeping this up to date with news release (because their release will getting old and might not stay available for download).

• What YOU can do to make it works ?

The FIRST LAZY WAY:

Remove the actual Python and scons program from your computer, then download and install the old python2.6 **AND** scons1.1.0 version for windows if they are still available for download.

The SECOND LAZY WAY: (has not been test yet and may not solve the trouble)

Download the latest python and install it on c:\python26 and the latest scons on c:\python26\lib\site-packages\scons-1.1.0\

OR THE MOST COMPLICATED WAY: Editing the scoms file.

File with no Extension and normaly "located" at "c:\msys\1.0\bin\" or might also work or be found there at "c:\mingw\bin\" you should use a proper Text Editor , do not even think to use the MS notepad because it does sometime files coruption, at least you may use MS WORDPAD at your own files risk !,Better to use the Free Notepad++ who really edit well available as portable application also.

For Editing the ORIGINAL scoms file :

Replace the line:

#! C:/Python26/python , by your real information and software version and path location:

#! Drive:/Python_version_location/python

AND the two next occurrences of the expression or chart: 'scons-1.1.0' by your actual 'scons-version.x.x.x.'

Try to launch again 'scoms' in the 'gSConscript.pylob2_source' folder from MSYS application (the emulated *NIX environment & prompt) , in fact the STEP 2 of this Wiki page, If 'scoms' start compiling - a lot of information will be writting in the MSYS application windows, you 'r done !

• IF NOT see those hint :

you might need to check and found if your scons is on the right path as for the scons v1 it is like C:\Python27\Lib\site-packages\scons-1.3.0\SCons\Script\SConscript.pyc

IF the path Drive:\Python_version_path\Lib\site-packages\scons-version.x.x.x\SCons\" is not , you may need also to modified some other chart or expression in quotation mark e.g 'scons-1.1.0' to 'scons-2.0.0' You should found anyway on your computer somewhere the file 'SConscript.pyc' if the scons is correctly installed.

This Help is there and is provided AS IS , its works on my Windows Vista 32bit, and this Details Help should stay here long enought the file glob2_required_libs_mingw-scons.tar.bz2 containing the **OUTDATED** 'scoms link code' ! ALSO I M SORRY FOR THE OVERALL TEXT DESIGN but I m not use with this Web-tools and formatting ! even making a web-link is a problem well the help page is not working so feel free to correct my text design code.

ISSUE #3.1 scons line 7 ImportError: No module named SCons.Script

Its more likely you got the right python26 but the scons is not the scons-1.1.0 version, if this version is not any longer available to download, try to EDIT the scons file with the your exact scons version. you can know it by looking for the file SConscript.py in your computer and look closely the path the name you look for is right after the "....site-packages\scons-1.3.0\SCons\Script\SConscript.pyc" .

More details on the Issue#3 who is related to.

ISSUE #3.2 ImportError: No module named SCons.compat or/and _scons_builtins

Your Python Version installed in your Windows is not compatible with scons , ALL Python v3.x.x.x Are NOT COMPATIBLE with Scons v1.1.0 or v2.0.0.final.0 (as I am typing this help august-2010), please consider to un-install it and get the python26 and scons-1.1.0 who is the best bet !

(related to Issue#3)

ISSUE #4. No SConstruct file found

( users made mistake ) This is because your are not in the working source directoring to compile or The Source code has been altered or missing ! re-do step by step the wiki skipping the Download & settings stages. a

cd glob2_source_building
scons

might help thoough !

ISSUE #Final. Glob2.exe *.dll missing (SDL or else)

This is happenning because you use the old_method by command line at after the compilation was done. Fixed it by doing the new method using mouse&keyboard along with Windows GUI, remember the 'test' folder on your desktop :)

Conclusion

That concludes this Mingw compilation tutorial.

When I will know How to use friendly the GUI Hgturtoise , I will Update this Tutorial, that mean it will have less command line ever, in fact command line will be limited to the ONLY Source code compilation , up to this comming day , take this Wiki has a reliable and Stable one , since I made effort to correct the main errors people got while folllowing it.

Surely, Section designing need yet to be perform, and it will be -especialy the ISSUES Section, I do not like the way it is shown ! Other improvement will follow soon, as Clearing messing Command line who are confusing MS_windows user.

• Compilation_story

Also to give you and idea on a 4 cores pentium cpu @ 2.33GHZ the compilation of the RC beta5 got 12 minutes and the binary (Glob2.exe file) "pound" 133MB !! well the other geek guys made one at 98MB so we are 1.32 time more weighty with this type of compilation. But clearly as today the comparison between Beta4 & Beta 5 is amazing by the Glob2 binary file size ! from 4.8kb to 100Mb .

• Trouble

If you have any NEW Trouble, please write a bug report and one of the Windows maintainers should be able to help you. More information on bug reports can be found at the Bug Reports page. Also think about the IRC , easy connexion via YOG.

Happy compiling.