Globulation2 - User contributions [en]

Compiling

2016-04-11T16:48:58Z

Giszmo: /* Debian/Ubuntu */ updated the dependencies

{{UserManualLinks}}

__TOC__

{{Message|Compiling on Windows|The instructions below will not work for Windows. To compile on that OS, please see the [[Mingw compilation]] guide, which explains how to compile globulation2 on windows using mingw.}}

==Compilation requirements==
{{Message|Compiling on Mac OSX|There is an easier way to get all the dependancies than to compile them all. See the [[MAC OS X Development]] page for more information.}}
For source tarbal, Mercurial source, and package installations, you'll also need to install these packages:
* [http://www.scons.org/ scons] build system
* [http://www.libsdl.org/index.php SDL 1.2] download SDL-devel and SDL
* [http://www.libsdl.org/projects/SDL_net/ SDL_net 1.2] download SDL_net-devel
* [http://www.libsdl.org/projects/SDL_image/ SDL_image 1.2] download SDL_image-devel
* [http://www.libsdl.org/projects/SDL_ttf/ SDL_ttf 2.0] download SDL_ttf-devel
* [http://www.speex.org speex] download current stable release
* [http://www.xiph.org/ libogg and libvorbis] can be found in their download-section. libspeex, too.
* [http://zlib.net/ zlib]
* [http://boost.org/ Boost C++ Libraries] download boost, boost-devel, including boost_thread and boost_date_time.
* (optional) [http://fribidi.org/ Fribidi] download GNU FriBidi

===Debian/Ubuntu===
The following terminal command will get you all the dependencies:
sudo apt-get install mercurial scons libsdl1.2-dev libsdl-net1.2-dev libsdl-image1.2-dev \
libsdl-ttf2.0-dev zlibc libspeex-dev libogg-dev libvorbis-dev libboost-dev libboost-thread-dev \
libboost-date-time-dev

== Compile from Sources ==
=== Source Distribution ===
* Get the [[Download and Install|source distribution archive]] from the download section.
* Extract the archive using a compression/extraction utility such as tar.
* Go in the extracted archive. If you have a Unix system (GNU/Linux, Solaris, Mac OS X):
** Run the 'scons' script to compile the game (it will check dependencies, install any you have missing)
*** If you want to install the game in a special place, instead of 'scons', type:
scons BINDIR="/path/to/install/bin" INSTALLDIR="/path/to/install/share"
** Install with a simple 'scons install' command (will install to the location you might have entered when compiling (BINDIR and INSTALLDIR)).
** Run the game by typing 'glob2'. If it doesn't work, type '/path/to/install/bin/glob2' instead.
** Note: in some GNU/+Linux distributions (eg: Archlinux), scons complains about not finding -lboost_thread (with boost already installed). A solution is to modify the SConstruct file to look for boost_thread-mt instead of boost_thread, and the modify the LIBS variable with boost_thread-mt, to link against this library. If you have root access you can create a symlink libboost_thread.so instead.

=== Sources from [[Mercurial]] ===
{{Message|Warning|The source from Mercurial is occasionally unstable and will break. It is not meant for playing games but only for development and testing.}}
==== The quick way ====
Use this if you want to get exactly one copy of glob2 repository to compile and run it. This is also the recommended way if you are sure you will not want to push only parts of your changes.
* Initial download
cd some_workspace_directory
hg clone https://bitbucket.org/giszmo/glob2
* Subsequent updates
cd glob2
hg pull
hg update
: '''pull''' will get all changes from the original repository into your repository
: '''update''' will get your local files to the latest revision. Use '''-C''' to loose all local changes.
==== The more complicated way ====
Use this if you want to commit several changes that you are not sure of being finished some day while at the same time you want to have access to a clean checkout, too.
* Initial download
cd some_workspace_directory
hg clone https://bitbucket.org/giszmo/glob2
* clone to a working directory
cd some_workspace_directory
hg clone glob2 glob2-work
* Subsequent updates
cd glob2
hg pull
cd ../glob2-work
hg pull
hg update
: '''pull''' will get all changes from the original repository into your target repository
: '''update''' will get your files to the latest revision. Use '''-C''' to loose all local changes.

* Read the README.hg and README files.
* Continue by following the [[#Source_Distribution|''source distribution'']] instructions from the 3rd step onwards.

[[Category:en]]
[[Category:User Manual]]

Videos

2014-11-13T16:13:33Z

Giszmo: /* Assassination campaign (5 minutes) */

{{Translations|View this page in|Article=Videos}}

===Fosdem 2008 presentation===
* [http://video.fosdem.org/2008/maintracks/FOSDEM2008-globulation2.ogg PAL quality]
*: you need the [http://www.theora.org/ ogg theora] codec to watch the video.
* [http://stephane.magnenat.net/data/glob2-fosdem2008-presentation.pdf slides of the presentation]

===Small game (13 minutes) : nct v.s. AI numbi===

* [http://www.youtube.com/watch?v=5_2GLBBXOl8 320x240 flash video on Youtube]
* [http://www.archive.org/details/Globulation2_small_game_vs_ai_numbi_movie 640x480 full quality ogg theora from archive.org]

=== Small game (18 minutes) : Giszmo vs 7 * AI-Numbi ===
In this video you see how to effectively use fruits to convert your opponents.
* not a single warrior is built
* no barracks
* [http://download.savannah.gnu.org/releases/glob2/videos/ the video]

===Really small game (5 minutes) : Migi vs. AiWarrush===
This video shows how to effectively counter the Warrush AI and beat him pretty fast.

* Youtube: [http://www.youtube.com/watch?v=JSP72nOazaI click here].
* Mpeg file: [http://www.box.net/shared/a8gk7fgmau click here].

===Assassination campaign (5 minutes)===
This is a video showing you how to beat [http://globulation2.org/forums/viewtopic.php?t=928 Assassination], a campaign created by Migi. It's about 5 minutes long. Actually playing the campaign usually takes about 5 times longer though.

* [http://www.youtube.com/watch?v=rZPLCCsqYZM the video on youtube].

===How to create one yourself===
[http://globulation2.org/wiki/Video_Creation_Howto How do I create a glob2 video?]

[[Category:en]]
[[Category:Contributor_Resources]]

Videos

2014-11-13T16:12:57Z

Giszmo: /* Small game (18 minutes) : Giszmo vs 7 * AI-Numbi */

{{Translations|View this page in|Article=Videos}}

===Fosdem 2008 presentation===
* [http://video.fosdem.org/2008/maintracks/FOSDEM2008-globulation2.ogg PAL quality]
*: you need the [http://www.theora.org/ ogg theora] codec to watch the video.
* [http://stephane.magnenat.net/data/glob2-fosdem2008-presentation.pdf slides of the presentation]

===Small game (13 minutes) : nct v.s. AI numbi===

* [http://www.youtube.com/watch?v=5_2GLBBXOl8 320x240 flash video on Youtube]
* [http://www.archive.org/details/Globulation2_small_game_vs_ai_numbi_movie 640x480 full quality ogg theora from archive.org]

=== Small game (18 minutes) : Giszmo vs 7 * AI-Numbi ===
In this video you see how to effectively use fruits to convert your opponents.
* not a single warrior is built
* no barracks
* [http://download.savannah.gnu.org/releases/glob2/videos/ the video]

===Really small game (5 minutes) : Migi vs. AiWarrush===
This video shows how to effectively counter the Warrush AI and beat him pretty fast.

* Youtube: [http://www.youtube.com/watch?v=JSP72nOazaI click here].
* Mpeg file: [http://www.box.net/shared/a8gk7fgmau click here].

===Assassination campaign (5 minutes)===
This is a video showing you how to beat [http://globulation2.org/forums/viewtopic.php?t=928 Assassination], a campaign created by Migi. It's about 5 minutes long. Actually playing the campaign usually takes about 5 times longer though.

* Youtube: [http://www.youtube.com/watch?v=rZPLCCsqYZM click here].
* Mpeg file: coming soon.

===How to create one yourself===
[http://globulation2.org/wiki/Video_Creation_Howto How do I create a glob2 video?]

[[Category:en]]
[[Category:Contributor_Resources]]

Videos

2014-11-13T16:11:20Z

Giszmo: /* Small game (18 minutes) : Giszmo vs 7 * AI-Numbi */ fixed broken link

{{Translations|View this page in|Article=Videos}}

===Fosdem 2008 presentation===
* [http://video.fosdem.org/2008/maintracks/FOSDEM2008-globulation2.ogg PAL quality]
*: you need the [http://www.theora.org/ ogg theora] codec to watch the video.
* [http://stephane.magnenat.net/data/glob2-fosdem2008-presentation.pdf slides of the presentation]

===Small game (13 minutes) : nct v.s. AI numbi===

* [http://www.youtube.com/watch?v=5_2GLBBXOl8 320x240 flash video on Youtube]
* [http://www.archive.org/details/Globulation2_small_game_vs_ai_numbi_movie 640x480 full quality ogg theora from archive.org]

=== [http://download.savannah.gnu.org/releases/glob2/videos/ Small game (18 minutes) : Giszmo vs 7 * AI-Numbi] ===
In this video you see how to effectively use fruits to convert your opponents.
* not a single warrior is built
* no barracks

===Really small game (5 minutes) : Migi vs. AiWarrush===
This video shows how to effectively counter the Warrush AI and beat him pretty fast.

* Youtube: [http://www.youtube.com/watch?v=JSP72nOazaI click here].
* Mpeg file: [http://www.box.net/shared/a8gk7fgmau click here].

===Assassination campaign (5 minutes)===
This is a video showing you how to beat [http://globulation2.org/forums/viewtopic.php?t=928 Assassination], a campaign created by Migi. It's about 5 minutes long. Actually playing the campaign usually takes about 5 times longer though.

* Youtube: [http://www.youtube.com/watch?v=rZPLCCsqYZM click here].
* Mpeg file: coming soon.

===How to create one yourself===
[http://globulation2.org/wiki/Video_Creation_Howto How do I create a glob2 video?]

[[Category:en]]
[[Category:Contributor_Resources]]

Building the .deb file

2012-10-04T19:51:12Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

#Install building tool:
#:<pre>sudo apt-get install dpkg-dev</pre>
#Install glob2 building dependencies:
#:sudo apt-get install debhelper quilt scons libsdl1.2-dev libsdl-image1.2-dev libsdl-net1.2-dev libsdl-ttf2.0-dev libglu1-mesa-dev libvorbis-dev libspeex-dev libfreetype6-dev libboost-dev libboost-thread-dev libboost-date-time-dev libfribidi-dev portaudio19-dev libboost-math-dev
#Get glob2 sources as it is suggested here [[Compiling#Sources_from_Mercurial]]
#Build a package:
#:<pre>cd glob2</pre>
#:<pre>dpkg-buildpackage -I.hg</pre>

[[Category:en]]
[[Category:Developer Resources]]

Mingw compilation

2012-10-04T19:50:27Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

This page explains how to compile Globulation 2 on windows using [http://www.mingw.org/ mingw].

== OVERVIEW -READ ME- to get smartly started ==

*READ-ME-FIRST
I Wanted to have a Quick Wiki to get through and While First time I followed it I got many pain due to many Errors Returned back to me from the compilation process, We fixed the most of them, and I wanted to help the people to know Why those Bug came from and sometime it was just another question, like ''How to choose my source'' to compile, since the First tutorial was really with none other explanations, I got lost.

On The other Hand Now,with a lot of investigation&time, the Tutorial is getting a kind a small Book, and this could '''bored''', or '''discouraged''' many of Windows Users, (linux users are more use to read documentations to do staff on their machines, and this is an advantage, they do understand quite well their machine behavior.

So I decided''' to create A Fast-way''' to get ride of compilation '''faster than never''', because I'm convince that many of you want to spend time on playing/testing the new release than reading the manual and the compilation.

'''PLEASE NOTE''' IF YOU HAVE SOME INTEREST ON COMPILATION AND HOW IT WORKS OR HOW IT DOES NOT WORKS --BUG CASES--- even HOW TO CUSTOMISE YOUR COMPILATION PICKING YOUR SOURCE PLEASE FOLLOW THE MAIN TUTORIAL TWO WAYS ARE The ''old command line'' WAY and THE ''MS windows way'' PLEASE NOTE THAT WE NEED TO USE COMMAND LINE FOR LAUNCHING THE COMPILATION SOFTWARE By HAND (2 code lines, quasi nothing) and making the bundle (3 more lines)

{{Message|From Windows VISTA and above Microsoft O.S| You need to run as an '''administrator''' to install packages/software.
:*The Msi installer type are perfect,but could required to accept some 'un-zip' authorization.
:*Some other type, deprecated one but compatible, got '''warnings''' from''' VISTA and above MS O.S''' ,some because their developers did not get a Digital Windows O.S-type certificate ( from Xp, Vista,7 -apparented to the MS O.S logo on the bundle software pack or on the product web pages )in this case '''DO accept the installation''' we need those and we know that they are not verify and sign by MS Digital certification but they run well.
:*Another one may ask for an authorization to install some other dependence files , '''do accept'''.
:*All_installation_pack_with_this_extension.'''exe'''" '''MUST BE''' run as administrator by right-clicking on it and selecting -''in the contextual menu''- '''run as an administrators''', specially for scons & MinGW.}}

.

== HIGH-WAY COMPILATION -Toll free- ==

HERE YOU WILL GET NO <bla bla bla> BUT IF YOU DO NOT STRICTLY OBSERVE THE DIRECTION YOU MIGHT FAIL DURING THE PROCESS ! Also if some step are obscure and you can't achieve it please Get off from the HIGH-Way to the next EXIT -free toll- and follow the MAIN TUTORIAL.
That said let's start it now !

*DOWNLOAD & INSTALL

:*GET [http://www.python.org/download/ Python 2.6] EXCLUSIVELY
:*Install into the directory "C:\Python26"
:*GET [http://www.scons.org/download.php scons-1.1.0] EXCLUSIVELY and install it [**AS ADMINISTRATOR**] into the same directory as the python got installed
:*GET [http://tortoisehg.bitbucket.org/ TortoiseHg].
:*GET [http://www.rarlab.com/ winrar] (winrar is a Commercial Shareware -with a 30day free-trial) or [http://portableapps.com/apps/utilities/7-zip_portable 7-ZIP] (gnu, but friendless)
:*GET [http://sourceforge.net/projects/mingw/files/ 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 "''Curren''t" when asked what version, and then
:* select the "''MinGW base tools''" (by default) and "''g++ compiler''" packages '''only'''
:*Download and install [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe 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).
:*GET&save [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2 GLOB2 LIBRARY ] in "c:\msys\1.0\"

* First ''manual'' GEAR

:*Un-zip the Archive ''glob2_required_libs_mingw-scons.tar.bz2'' into "c:\msys\1.0\"
{{message|TIP|OVER-WRITE FILES AND FOLDERS MUST BE ON or GRANTED on Vista and above OS.Tell '''Yes for all''' if this it's asked to you.}}

* Second GEARS
We'll get the 'Original-Project'
:*Get there "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: "https://bitbucket.org/giszmo/glob2" 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 recommended''' ! -about 3mins@ 6Mi-bit/s -

*CLONING: things get faster

:*Create a Sub-Directory called "glob2_source_building"
:*Right clicking on this new folder, will open the contextual menu, then
:*Select TortoiseHG>>Clone
:*Set the source path to the " repository" folder
:*In the "advanced options" Check the box "clone to Revision" and in the next field, fill in that: ''default''
:*launch the clonning process by pressing the button.

*UPDATING: Never faster than ever [OPTIONAL !!!!]
''clony'' do an update anyways -''from the source path set above''.And for the first time -''following this wiki''- your repository data are fresh food ! so on the High-way we decide to skip this ! ''Further informations about this in the main tutorial''.

* Third GEARS
Alright budy, now time to let's free your Engine HORSES, shifting the third gears :)

:*Open msys by double clicking the desktop icon,
:*Could you type the following code;
''hint: The "TAB KEY" help you to finish to fill up the path name use it to save time and mistake''.
cd /glob-compilation/glob2_source_building
scons

The process -compilation- Could take a while (minimum 10 mins on recent computer)The cursor or prompter is blinking and a lot of information quickly print out.The process ending when no more information are printing in the "yellow command line" windows and the prompter is '''not''' blinking and Marine-blue you should normally find the glob2.exe in the folder ''glob2_source_building'' if not you need to take the next exit, getting off the High-way, and follow the MAIN TUTORIAL, sorry.

{{message|NOTE: On old/tired/busy computer| this process could take a while, even HOURS !
PLEASE NOTE '''also''' that you could check out the "Possible Issues" section scrolling all your way down this page, and look for some possibles common ISSUES/BUGS/MISTAKES or a solution if any.}}

* Fourth GEARS
If you read this is because all things goes well, congratulation, you are a fine compilitor-pilot, now let's shift the fourth gears.

:*Make a 'TEST' directory.
:*Copy into it all the file found in "C:\msys\1.0\local\lib"
:*Copy also the Glob2.exe from ''glob2_source_building''.
:*Copy the SDL.dll from "C:\msys\1.0\local\bin".
:*GET READY BUDY, your Engine Horses make you good, alright -->launch glob2.exe
''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.''
{{message|On Vista and above|you could get an alert saying''' this application do not answer/respond''' or similar, and ask what to do, you must select '''Wait until the program respond''' or similar.As it as been told this could take a while (e.g ''30s on recent not busy computer'', but much more on a busy or old computer -like one core computer).
OF COURSE this is different if the application '''crashed''' by an alert saying this ''application has stop to run in an'' '''unexpected manner''' or similar !}}

* Fifth GEARS (stage under testing)
Budy is the Test was good? You 'r certainly feeling good, right now ! Let's shift the 5th Gears, Do we need it? Well if you do want to set an installation-bundle-pack, yes you need it!

:*In MSYS, run the following codes making a ''windows bundle set-up'' file:
cd /glob-compilation/glob2_source_building
cd bundle
glob2_make_win32.sh

If all things goes well, an binary(.exe) is ready, making installation on windows computers easier than ever ! Look in the '''bundle''' folder. Test it (install and play), and if it works, send it to your friends ;)

* The Happy Ending :D :) :-D
I hope this first trip was AwEsOmE, if you need to customize your ''baby'' take your way off by the MAIN TUTORIAL EXIT, thank you for riding on our compilation-High-way, We wish to you a Happy & nice day :D

.

== MAIN TUTORIAL ==
Here you will Have, I wish, all the information'''s''' you need for learning on '''how to compile''' Globulation2-project to get a binary(.exe).''If you don't care about this please do follow the earlier (above) HIGH-WAY Tutorial/stage''.

{{message|MESSAGE| Main tutorial are completely under remodeling it still working though, some informations could be redundant.The goal is to have a very nice Mercurial Repository System Overview Definition , to assist you in picking your source code you want to build for MS_Windows_O.S and to have a Quick & clear View of What to do. As you can see '''A lot of work''' ! }}

=== Command Line Method old school & well efficient ===

==== DownLoad & Installation ====
*Download and install Python2.6 '''EXCLUSSIVELY''' into the directory "C:\Python26" (default install is Python26, don't change this)
*Download and install Scons-1.1.0 '''EXCLUSSIVELY''' into the same directory as the python install (C:\Python26\)
*Download and install stable Mercurial locally so the command hg will work. When you get to the end of the install, make sure you check "add mercurial to your computers search path" or something similar.
*Download and install NSIS into all its default installation folder "C:\Program Files\NSIS\".(For creating a windows installer)
*Download and install MinGW into the directory c:\mingw (lower case). During installation,
*select "Current" when asked what version,then
*select the MinGW base tools and g++ compiler packages only And,
*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.
*When it ask you to indicate the directory where it is installed, type in c:/mingw (yes, with a forward slash as the program prefers it that way).
*Download glob2 required library ''glob2_required_libs_mingw-scons.tar.bz2'' &save it at "c:\msys\1.0\"
*Double click the MSYS icon that has been placed on your desktop during MSYS's installation.
*untar the libraries using the command:
cd /
tar jxf glob2_required_libs_mingw-scons.tar.bz2 -C /
''This process could take a while''

==== Globulation 2 cooking Preparation ====

===== Stage 1:Ingredient =====
*Released source code ingredient
If you wish to Compile from Released source code follow this stage if not skip to the next ''Ingredient'' mark below.
:*Download&Save The Archive Source Code Released (e.g glob2-0.9.4.4.tar.gz)and
:*extract it into "c:\msys\1.0\"
cd /
tar zxf glob2-X.x.x.x.tar.gz -C /
''zxf: mean z for .gz archive file, x for extracting, f force it.So if '''ever''' the extension of the source is a'' .'''bz2''' use '''jxf''' instead of '''zxf'''

:*then run (changing the version numbers):
cd /
mkdir glob-compilation
cd glob-compilation
mkdir glob2_source_building
cd /
mv glob2-X.x.x.x.tar.gz glob-compilation/glob2_source_building

*Using the Mercurial software repository ingredient
:*Getting Globulation 2 from mercurial:
cd /glob-compilation
hg clone https://bitbucket.org/giszmo/glob2 repository
:*Get -branch you would like to work/play, you might also get other branches, such as beta4-rc, more information in the Definition section (not yet created):
hg clone -r default repository glob2_source_building

:*To get the latest code [OPTIONAL, not required], run:
cd glob2_source_building
hg update -C tip
More information about update, tag like tip, and branch in the definition section (under construction section of this wiki, not yet released though)

===== Step 2: Cooking =====
Start compiling Globulation 2. Don't worry about the warnings. If something is wrong, it will grind to a halt and it will let you know why.
Here you might got many errors please check out the ISSUE SECTION by scrolling ALL your way down.

{{message|Message|Also on a slow/busy/tired Computer this process burn a lot of time & cpu energy.
On a recent computer it takes an average of 12 mins, but could be multiply by 10 or more according to your system characteristic -specially cpu core clock frequency.}}

:*To launch the compilation, run:
cd /glob-compilation/glob2_source_building
scons -j5 --random --cache-force
The argument are optional and are add here when you got a multi-core CPU , that command order to compile on 5 other cores simultaneously! [Multi-threading or tasking]

More Details will be found at [http://www.scons.org/doc/HTML/scons-man.html scons MAN PAGE].

''Normally if all is done you should see the blinking cursor in the shell,return to a new line with a $ followed by the no more blink cursor (marine blue color normally).Also as a rule of dumb you should get the Binary from a succesful cooking/compilation, So Have a look inside'' ''glob2_source_building'' folder ;)

===== Step 3: Testing =====

Once compiling has successfully finished
*Make a 'TEST' directory call "test" at "C:\msys\1.0\glob-compilation".
*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\glob-compilation\glob2_source_building\src\" into this 'Test' directory you have just made.
*Copy the SDL.dll from "C:\msys\1.0\local\bin" and past it into your 'test' folder, and...
*launch it ! ENJOY IT !

{{message|NOTE|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.
*ON VISTA and Above set the alert if any to '''Wait until the application respond'''.}}

===== Step 4: Packaging (SECTION UNDER TESTING) =====
In this Stage We will Build a Globulation2 NSIS package.

*In MSYS, run the following codes to compile a windows installable exe file:
cd /glob-compilation/glob2_source_building
cd bundle (or ''windows'' if bug)
glob2_make_win32.sh

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

=== ! ! ! SECTION UNDER REMODELING ! ! ! ===

NOW THE COMMAND LINE IS REDUCED to the minimal -while the command line method remain in the wiki for the linux-lover-, This wiki may seems long to read, but it does contain many informations to dig deeper later than a simple compilation, and this will be really a hand when a question like, ''Can I choose my source to compile ?'', ''How I patch it thought ?''.... exciting is'n it.

*DOWNLOAD&INSTALLATION

:* Download [http://www.python.org/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 [http://www.scons.org/download.php '''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 HgTortoise we come along with mercurial software.

{{message|PLEASE INSTALL| '''ONLY ONE''' Mercurial ! The Mercurial version 1.6.0 '''with Turtoise or not''' work perfectly ! }}

::*EITHER ''Friendly Windows'' & command line: [http://tortoisehg.bitbucket.org/ GET TurtoiseHG NOW] '''along with mercurial''' out of the box !

::*OR ''Command line Only'', [http://bitbucket.org/tortoisehg/thg-winbuild/downloads/mercurial-1.6.0.msi Mercurial-1.6.0 stable without TortoiseHg]. For the futur (''When the link will be broken'') you can check this area:[http://mercurial.selenic.com/downloads/ other download link] to get mercurial.The old Mercurial data References for this Wiki could be found [http://mercurial.berkwood.com/ there] (Outdated-support).

:::*What exactly is HgTortoise, 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 Graphical User Interface (GUI) 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 [http://tortoisehg.bitbucket.org/ their Web Site] here, please.

*OPTIONAL DOWNLOAD:

(To create a windows installer)
:*Download and install [http://nsis.sourceforge.net/Download NSIS] into all its default installation folder "C:\Program Files\NSIS\".

(To be proud of using MS WINDOWS GUI for tarballing archives matter)
:* Look for[http://portableapps.com/apps/utilities/7-zip_portable 7-Zip] (GNU) or [http://www.rarlab.com/ 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 ? )
:*[http://portableapps.com/apps/development/notepadpp_portable Look for notepadd++] (free gnu software) to edit code lines (specially for scons).

.

=== Setting up MinGW and MSYS ===
:*Download [http://sourceforge.net/projects/mingw/files/ 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 "''Curren''t" when asked what version, and then
:* select the "''MinGW base tools''" (by default) and "''g++ compiler''" packages '''only'''
:*Download and install [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe 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 ===
==== Windows Method ====
:*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 [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2 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.

{{message|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.

==== Linux like Method ====
'''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 https://bitbucket.org/giszmo/glob2 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 [http://www.selenic.com/mercurial/hg.1.html#clone 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 [http://www.selenic.com/mercurial/hg.1.html#branch 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 [http://www.selenic.com/mercurial/hg.1.html#clone 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 -I''f I correctly get the meaning in the manual'' see: [http://www.selenic.com/mercurial/hg.1.html#update 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'')

'''THIS SECTION HAS SUCCESSFULLY BEEN TESTED and APPROVED !'''

:*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: "https://bitbucket.org/giszmo/glob2" 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 [https://bitbucket.org/giszmo/glob2 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 next by arrow you can see a list of the actual branches in the repository you are actually exploring.

:::* Branch Definition
A NEW changing state in the repository -where code data are recorded- and has been created from an another branch that is not a head -the very beginning of a any branch. If a new branch is named, it becomes a '''named branch'''. If a new branch is not named, it becomes an '''anonymous branch'''. A branch name should represent the tipmost revision of that branch.

::::*Beyond the water.
(you can skip it if you don't care about How the code is organized)

Branches are like real trees branches they grow on a tree from the ground zero (the first branch call -NULL- (ID 00000000). and from branch to branch they keep growing, and like real tree they have communication point-node- between each one another (merge) and for easiest classification the use of name and tag name along with Unique SHA1-ID.When a Branch got mature and got merge into the trunk (the main first branch call by default: ''default''), on the website and the hgturtoise software they are represented as different colored lines.The different between real tree and the ''program'' is that the real tree branches have his branches that keep growing, in opposition, with the ''Mercurial Program Branches'', which when a branch is not any longer supported -mainly because the goal is reached and then are merge into one another or they miss their goal and have their Head set to be closed.Then naturally they could not grow any longer, they just Disappear -into the main branch or ended in a dead-end -as I believe- see the [http://www.selenic.com/mercurial/hg.1.html Mercurial Documentation] for Exact Details and our [http://globulation2.org/wiki/Mercurial local Documentation].

Branches are like a small-working-pool which is based on an existing release (earlier branch)so branches are set to define some news changes that the dev or devs team wish to implement and for testing game core stability and avoiding corruption the Code are split into branches - e.g the famous 2007_Game_core_Writing, for this example a tag has been created to avoid people to update from the main branch to the experimental branch. Branch functionality are very complex to understand and to explain.When a experimental branch get stable and add an new features or fix a bug ,they are ''merge'' into the main branch called ''default'' at this point if the dev feel the need for, He/she could set a tag to refer to his improvement.

:::::*Cloning a branch -example-
Cloning a branch that has been split from the main branch for experimentation and not yet get merge into it, will give you the game source data that this dev team are working on, due to the fact that the code is under writing of course it may be not always be compilable, specialy since other well known bug could be fixed on other branches or in the main default branch, who do not profit to a particular branch unless they get merge into.I told you complicated staff.

:::::* Head
it's even more complicated if you can imagine that branch should have a ''Head'' and many head could exist in the ''Mercurial system'' but are not recommended. Head are define as a very new branch beginning with no descendants yet.

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.

::::* SUMMARY
The 'Default' is the last one where every one look at for improvement.not necessary stable. after come the 'betaX-rc' -''branch name''- 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 ! However I found in some case that betaX-rc are less stable than the Default branch !
And the other are mostly dedicated for debugger, tester, and other geeks!

:* CLONYING our Branch [DIRECTION]
(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 [DIRECTION]
This stage may be useful if you are getting to work on a long term with mercurial system,if you are just a fast windows player skip this part to the next.

{{message|Revision| is A repository snapshot at a particular time.Therefore earlier revisions can be updated to by using the Update command.It can be specified as a changeset '''revision number''', a '''tag name''', or a '''unique SHA-1 hash value''' substring of the changeset.

The tag '''tip''': is the snapshot with the highest revision number.It is the changeset most recently added in a repository.

The tag '''betaX''' (X is a number): are tag created to refer to a particular working branch bond normally to the branch name "betaX-rc" }}

When your local Globulation2 Project Repository is getting '''old''' -''for months''- you can use the Update option find in the contextual menu under the HgTurtoise section, when right clicking on a folder. The best bet is to update either your ''local repository'' or just your working source folder "''glob2_source_building''".Using mostly the '''tip''' tag or '''default''' or a betaX-rc -where X is a number.

::*Details
This stage , in my opinion as I am writing, is optional, the purpose is to get the last Revision that has been coded for a typical branch, they are called Tags, Revision.When using a local '''repository''' up to date, the update is not needed.See the [https://bitbucket.org/giszmo/glob2 online GRAPH improvement] to see if you need to update your data and compare to your local repository Data using HgTurtoise explorer on the '''repository''' folder -that you has cloned maybe for a while.

:::*Tag -definition-
Do not hesitase to get read those pages for further Informations:
:::::* Local Mercurial [http://globulation2.org/wiki/Mercurial#A_quick_overview_of_Mercurial wiki page].
:::::* Hg [http://www.selenic.com/mercurial/hg.1.html#tag online Manual] Page.

::::*Get Beyond the water.
:::::*A tag name is associated with a revision ID number.
:::::*The special tag "tip" is always identifies the most recent revision.
:::::*Tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.

example:
If you update to an "Revision" -tag-,let's say the beta4-rc you was an branch aside from the main one -default-, the beta4-rc was under development on the developer local repository, until they commit their work online.

_
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 option box only and verify the other are uncheck.
::* 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

===Step 2 C Direction ===

:*Starting Globulation 2 compilation.
:*Open msys by double clicking the desktop icon, type the following code into the emulated *NIX-shell;
cd /glob-compilation/glob2_source_building
scons
HINT: The "TAB KEY" help you to finish to fill up the path name use it to save time and mistake.

===Step 2 A&B&C The TEST After a Success compilation ===

:*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.
{{message| if you went from C Step| The binary will be found into ''C:\msys\1.0\glob-compilation\glob2_source_building'' directory.}}
:*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.

===Building a Globulation 2 NSIS installer===

When You had run the STEP2 A&B:
:*In MSYS, run the following codes to compile a windows installable exe file:
cd glob2_source_building
cd bundle
glob2_make_win32.sh

When You had run the STEP2 C:
:*In MSYS, run the following codes to compile a windows installable exe file:
cd /glob-compilation/glob2_source_building
cd bundle
glob2_make_win32.sh

:*If all things go well, an exe ready for installation on windows computers is now ready within the '''bundle''' 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.0 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 look there].
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 "unix-kind-link" who has been designed for Python 2.6 AND scons-1.1.0 Versions ONLY due to the fact that today the Python version and scons have and will evolve their name, their path will too, breaking the scons unix-type-link !
That said, as you see The Trouble will come over and over if the way to bond the scons to mingw sh (unix command bash, & emulated environment) will stay like that -none dynamic-

:* How the Community can fix it ?
Here some ideas:
We need to maintain a right scons file provided in the [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz tarball file ] call 'Prerequisites' (glob2_required_libs_mingw).

:* What '''YOU''' can do to make it works ?
::*The EASIEST, SIMPLEST,EFFICIENT 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.

::*OR THE MOST COMPLICATED WAY: Editing the scons file.

Scons 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++ [http://portableapps.com/apps/development/notepadpp_portable -get it now-]''' who really edit well available as portable application also.

:::*'''Editing''' the ORIGINAL scons file :
FOR THIS WORK YOU NEED TO USE ''notepad++'' (gnu) [http://portableapps.com/apps/development/notepadpp_portable get it now].

::::*Replace the line:

#! C:/Python26/python ,
by your real python version (it is either 26 or 27 , newer version are not compatible) :

#! 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.'

example:

Original scons link:
#! C:/Python26/python

from os.path import join
import sys

sys.path = [ join(sys.prefix, 'Lib', 'site-packages', 'scons-1.1.0'),
join(sys.prefix, 'Lib', 'site-packages', 'scons'), join(sys.prefix, 'scons-1.1.0'),
join(sys.prefix, 'scons')] + sys.path
import SCons.Script
SCons.Script.main()

Modified Scons for using Python2.7 and scons-2.0.0.final.0 as:

#! C:/Python27/python

from os.path import join
import sys

sys.path = [ join(sys.prefix, 'Lib', 'site-packages', 'scons-2.0.0.final.0'),
join(sys.prefix, 'Lib', 'site-packages', 'scons'), join(sys.prefix, 'scons-2.0.0.final.0'),
join(sys.prefix, 'scons')] + sys.path
import SCons.Script
SCons.Script.main()
(3 entry has been changed, for this example)

:::*Try again the STEP2 according to what STEP1 you followed, If 'scons' 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 the file 'SConscript.pyc' on the right path following this model
"''Drive:\Python_version_path\Lib\site-packages\scons-version.x.x.x\SCons\Script\SConscript.pyc''"
IF the problem persist uninstall scons first and python after, and INSTALL PYTHON2.6 and SCONS-1.1.0 , that will fixed your trouble, no need to uninstall MSys neither MinGW.

*'''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" .

YOU NEED to have installed as an Administrator "'''scons-1.1.0'''" this exact version IF not the Issue will occur The Error look 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 :(

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 !

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

Error code look 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 !

(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 !

*'''MOTD'''
This Help is there and is provided AS IS , its works on my Windows Vista 32bit, and this Details Help should stay here long enough as long the file glob2_required_libs_mingw-scons.tar.bz2 contain the **OUTDATED** 'scons unix-link' ! Thank you for the reading

==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 .

:*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.

[[Category:en]]
[[Category:Developer Resources]]

Team

2012-10-04T19:48:17Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

This page is automatically updated from the
Mercurial AUTHORS file. 
Any change you make may dissapear.
==Game design, initial programming==

:*Luc-Olivier de Charrière
:*Stéphane Magnenat

==Maintainer==

:*Bradley Arsenault (As of August 2006)
:*Stéphane Magnenat (Until August 2006)

==Further programming==

:*Bradley Arsenault (Nicowar AI, Echo AI System, New Map Editor, Miscellaneous Bugfixes)
:*Martin Nyffenegger (SGSL)
:*Andrew Sayers (Miscellaneous bugfixes)
:*Leo Wandersleb (Perlin-noise based map generation and clouds, ...)
:*Hein-Pieter van Braam (IRC patch, debugging)
:*Martin Voelkle (GUI, bugfixes and more)
:*Joe LeBlanc (YOG & IRC fixes and improvements)
:*Emmanuel Eckard (CreditScreen JJ)
:*Kevin Clement (improved settings menu & bugfixes)
:*Ahmad Sayed (bidi text support)
:*Kai Antweiler (gradient algorithms, bugfixes, ...)

==Graphics==

:*Emmanuel Eckard (drawing new buildings)
:*Cyrille Dunant (coloring new buildings)
:*Andrew Sayers (new grass and sand)
:*Matthew Marshall (new units)
:*Stéphane Magnenat (GUI, new water)
:*Joey Marshall (additional drawing, coloring)
:*Luc-Olivier de Charrière (swarm, old terrains, buildings and units)
:*Gabriel Walt (GUI)
:*Leo Wandersleb (Clouds, Headsets)

==Music==

:*[http://jacques.grivaz.net Jacques Paul Grivaz]

==Translations==

:*Julia Schmitt (Deutsch)
:*Michal Turek (Czech)
:*Przemyslaw Kaminski (Polish)
:*Łukasz Demianiuk (Polish)
:*Martin Nyffenegger (Deutsch)
:*Matthias Warkus (Deutsch)
:*Martin Hinrichs (Deutsch)
:*Manuel Soukup (Deutsch)
:*Denis Lianda (Russian)
:*Munteanu Olimpiu Andrei (Romanian)
:*Vakvarju (Hungarian)
:*samaritan (Serbian)
:*Daniel Nilsson (Swedish)
:*christooss (Slovene)
:*Matic Ahacic (Slovene)
:*Heine Laursen (Danish)
:*Tobe Deprez (Dutch)
:*Elías Díaz Molins (Catalain - Català)
:*Stefan Kangas (Swedish)
:*David Morán (Spanish)
:*Fernando J. Rodríguez (Portuguese, Spanish)
:*Igor TAmara (Spanish)
:*Sébastien Le Ray (French)
:*Muhammet Kara (Turkish)
:*Adam Olausson (Swedish)
:*White Raven (Slovensky)
:*Anonymous (Spanish)
:*Raoul Verveer (Nederlands)
:*David Barnett (English)
:*Federico Massi (Italian)
:*Erik Blomqvist (Swedish)
:*Osoitz Elkorobarrutia (Basque)
:*IGA Tosiki (Japanese)

==Maps and campaign==

:*Bradley Arsenault (new tutorial)
:*Joey Marshall (Joey campaign)

==Game Packaging==

:*Vincent Deffontaines (Debian)
:*Sebastian Gerlach (Win32 VS)
:*Alexandru Munteanu (Win32 mingw32)
:*Dejan Lekic (Win32, Fedora)
:*Jens Reimann (Fedora)
:*Martin Nyffenegger (Mac OS X)
:*Jean-David Maillefer (Mac OS X)
:*Kieran (Win32 runtime/executable, Mandriva RPM/Source RPM)
:*Christian (Win32 executable images)
:*Thierry Thomas (FreeBSD)
:*"Dave Vasilevsky" (Mac OS X)
:*Ruben Zilibowitz (Mac OS X)

==Internet, documentation and community==

:*Luc-Olivier de Charrière (yog metaserver)
:*Kyle Lutze (hosting, phpbb/mediawiki integration)
:*Drazak (hosting)
:*Munteanu Olimpiu Andrei (wiki)
:*Stéphane Magnenat (server, wiki, savannah, forum)
:*Gabriel Walt (hosting, old CMS, wiki, forum)
:*Munteanu Alexandru (phpbb/mediawiki integration)
:*Martin Voelkle (wiki)
:*Leo Wandersleb (wiki)
:*Louis Gagnon (wiki)
:*Loki Azgorodin (#glob2)
:*Dejan Lekic (#globulation2)
:*Ghislain Leveque
:*Kieran (wiki, savannah project site)

==Usability review==

:*Ellen Reitmayr

Compiling

2012-10-04T19:40:34Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

{{UserManualLinks}}

__TOC__

{{Message|Compiling on Windows|The instructions below will not work for Windows. To compile on that OS, please see the [[Mingw compilation]] guide, which explains how to compile globulation2 on windows using mingw.}}

==Compilation requirements==
{{Message|Compiling on Mac OSX|There is an easier way to get all the dependancies than to compile them all. See the [[MAC OS X Development]] page for more information.}}
For source tarbal, Mercurial source, and package installations, you'll also need to install these packages:
* [http://www.scons.org/ scons] build system
* [http://www.libsdl.org/index.php SDL 1.2] download SDL-devel and SDL
* [http://www.libsdl.org/projects/SDL_net/ SDL_net 1.2] download SDL_net-devel
* [http://www.libsdl.org/projects/SDL_image/ SDL_image 1.2] download SDL_image-devel
* [http://www.libsdl.org/projects/SDL_ttf/ SDL_ttf 2.0] download SDL_ttf-devel
* [http://www.speex.org speex] download current stable release
* [http://www.xiph.org/ libogg and libvorbis] can be found in their download-section. libspeex, too.
* [http://zlib.net/ zlib]
* [http://boost.org/ Boost C++ Libraries] download boost, boost-devel, including boost_thread and boost_date_time.
* (optional) [http://fribidi.org/ Fribidi] download GNU FriBidi

===Debian/Ubuntu===
The following terminal command will get you all the dependencies:
sudo apt-get install scons libsdl1.2-dev libsdl-net1.2-dev libsdl-image1.2-dev \
libsdl-ttf2.0-dev zlib-bin libspeex-dev libogg-dev libvorbis-dev libboost-dev \
libboost-thread1.40-dev libboost-date-time1.40-dev
* Adding 'mercurial' to that line will get you all you need to get involved.

== Compile from Sources ==
=== Source Distribution ===
* Get the [[Download and Install|source distribution archive]] from the download section.
* Extract the archive using a compression/extraction utility such as tar.
* Go in the extracted archive. If you have a Unix system (GNU/Linux, Solaris, Mac OS X):
** Run the 'scons' script to compile the game (it will check dependencies, install any you have missing)
*** If you want to install the game in a special place, instead of 'scons', type:
scons BINDIR="/path/to/install/bin" INSTALLDIR="/path/to/install/share"
** Install with a simple 'scons install' command (will install to the location you might have entered when compiling (BINDIR and INSTALLDIR)).
** Run the game by typing 'glob2'. If it doesn't work, type '/path/to/install/bin/glob2' instead.
** Note: in some GNU/+Linux distributions (eg: Archlinux), scons complains about not finding -lboost_thread (with boost already installed). A solution is to modify the SConstruct file to look for boost_thread-mt instead of boost_thread, and the modify the LIBS variable with boost_thread-mt, to link against this library. If you have root access you can create a symlink libboost_thread.so instead.

=== Sources from [[Mercurial]] ===
{{Message|Warning|The source from Mercurial is occasionally unstable and will break. It is not meant for playing games but only for development and testing.}}
==== The quick way ====
Use this if you want to get exactly one copy of glob2 repository to compile and run it. This is also the recommended way if you are sure you will not want to push only parts of your changes.
* Initial download
cd some_workspace_directory
hg clone https://bitbucket.org/giszmo/glob2
* Subsequent updates
cd glob2
hg pull
hg update
: '''pull''' will get all changes from the original repository into your repository
: '''update''' will get your local files to the latest revision. Use '''-C''' to loose all local changes.
==== The more complicated way ====
Use this if you want to commit several changes that you are not sure of being finished some day while at the same time you want to have access to a clean checkout, too.
* Initial download
cd some_workspace_directory
hg clone https://bitbucket.org/giszmo/glob2
* clone to a working directory
cd some_workspace_directory
hg clone glob2 glob2-work
* Subsequent updates
cd glob2
hg pull
cd ../glob2-work
hg pull
hg update
: '''pull''' will get all changes from the original repository into your target repository
: '''update''' will get your files to the latest revision. Use '''-C''' to loose all local changes.

* Read the README.hg and README files.
* Continue by following the [[#Source_Distribution|''source distribution'']] instructions from the 3rd step onwards.

[[Category:en]]
[[Category:User Manual]]

Source Understanding Guide

2012-10-04T19:38:48Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

{{Message|outdated content|most of the following referenced documents are outdated}}

You can start understanding the code by:
* To have an idea of the main loop : [https://bitbucket.org/giszmo/glob2/src/8d2f3a39946a/doc/main%20engine%20loop.txt doc/main engine loop.txt]
* To have an overview of the glob2's '''class structure''', you can begin by reading the doc/sourceCodeUnderstanding.txt file in glob2's [[Mercurial]]
* To have an idea of '''unit allocation''' doc/unitAllocationUnderstanding.txt
* To have a list of all '''capitals quick comments''' , read doc/sourceCodeTagging.txt
* To have an overview of the `BuildingType system, read doc/BuildingType.txt
* For a listing of all the BuildingType INT's read [[BuildingSourceInts]]
* To have an insight on how the actual YOG system works, and to understand the complexity of FW/NAT passing, read doc/YOGUnderstanding.txt
* To have a '''quick summary of the unit''', read doc/unit.txt
* To understand how '''building with connecting capabilities (like walls) are ordered''', read doc/wall.txt
* The [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00042.html scripting language] thread on the mailing list threw up a few interesting points about SGSL. Noteably, [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00063.html these] [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00085.html two] posts by nct.
* [http://lists.gnu.org/archive/html/glob2-devel/2005-07/msg00014.html This thread] on the mailing list has some discussion of map-related functions.

[[Category:en]]
[[Category:Developer Resources]]

Releasing a new version

2012-10-04T19:34:59Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

{{Message|Some permissions needed|The following guide assumes that you have upload ability to savannah (you will need to be a group member), and write access to Mercurial (contact Nct if you need a username and password access). If you don't have these, then you probably arn't allowed to make releases :P}}

== Planning a release ==

Globulation2 is developed in a very open way concerning release cycles and versions maintained. Since using Mercurial it became easier to keep older versions updated as committing bugfixes there and merging them up the ladder to default is very easy.

* First thing to do when planning a release is to propose it. Email the development mailing list and say you think a release should be made.
* If no-one complains within days go into the test phase

== Test phase ==

* branch off a release candidate which '''must''' be used for testing and bugfixing '''only''' - and finally will be released:
hg clone https://bitbucket.org/giszmo/glob2
cd glob2
hg update -r default
hg branch beta<nowiki>[number]</nowiki>-rc
* Increment version number in SConstruct (find and edit env["VERSION"])
* Run these 3:
scons
scons install
scons dist
* make sure all three work (compile, install, and package). If that works, then commit and push your changes
* Adjust the [[Changes|Changelog]]
* Now announce (on the mailing list) that you branched off the release candidate and that everyone who wants to help testing or fixing it can do the following:
hg clone https://bitbucket.org/giszmo/glob2
cd glob2
hg update beta<nowiki>[number]</nowiki>-rc
* Now wait for the go of all relevant developers and make sure, all cases are tested in depth including
** custom maps
*** with all AIs and
*** all maps played
** map editor and
*** playability of those maps
** tutorial and
** campaign
** LAN and YOG both with
*** more than two players and with
*** all major systems (Linux, Mac and Windows preferably
*** both 32bit and 64bit) involved.
** ...

;Note 1: Bugfixes should go into the oldest maintained branch having that bug and then be merged up into later branches like this:
hg update beta1-rc #beta1-rc is defninitely not supported anymore. Decide for yourself where you want to have the bug fixed.
<fix what is wrong>
hg commit -m"bugfix ..."
hg update beta2-rc
hg merge beta1-rc
hg commit -m"merge"
...
hg update default
hg merge beta<nowiki>[number]</nowiki>-rc
hg commit -m"merge"

;Note 2: ''hg update tip'' is almost always a bad idea after having pulled. tip might be some random branch. Use the branch name when using update. If using
;Note 3: Normal glob2 development can take place in the main branch (i.e. default) as usual.

== Release phase ==
=== Testing ===
* Pull a new copy of the release branch:
hg clone https://bitbucket.org/giszmo/glob2
hg clone -r release-rc glob2 glob2_release
cd glob2_release
hg update tip
* Clear:
scons -c
* Compile somewhat optimised:
scons CXXFLAGS="-O2 -g"
* if any problem occurs, then the release candidate is not ready for release! (the final release could be compiled without the -g and with -O3 but right now -g -O2 is a reasonable trade-off between speed and debugability)
* Install:
scons install
* if any problem occurs, then the release candidate is *still* not ready for release!
* Test the resulting installed:
gdb glob2
* if any problem occurs, then the release candidate is nearly ready for release, but too buggy to go out right now, wait another day or two! Never ever feel pressed to get out a release within hours or days. If You have bugs making this release worse than the last one for some players, you may make those players leave glob2 and you cause a lot of trouble getting things straight later. The transition between 2 versions is always a problem and the better the new version the faster this transition will be.

=== Releasing ===
* If the testing above was successfull, run 'scons dist' to create a tar.gz package.
* [[Uploading_to_Savannah|Upload it to Savannah]] in the folder relating to their version (for example, alpha22 = 0.8.22/).
* Send a mail to the development mailing list, update the wiki, update savannah news, and tell rest of the world about the "Good news" ;-)

[[Category:en]]
[[Category:Developer Resources]]

Mingw cross compilation

2012-10-04T19:31:28Z

Giszmo: https://bitbucket.org/giszmo/glob2 again

This page explains how to build and test glob2 for Windows on a Debian/Ubuntu GNU/Linux operating system.
To see how to compile it natively on Windows, please see [[Mingw compilation]].

===Compile globulation2 for Windows on Debian using mingw===

#Install a mingw compiler:
#:<pre>sudo apt-get install mingw32-binutils mingw32 mingw32-runtime</pre>
#Install NSIS (required only if you want to build NSIS installer):
#:<pre>sudo apt-get install nsis</pre>
#Create the following directory:
#:<pre>mkdir build</pre>
#:<pre>cd build</pre>
#Download glob2_required_libs_mingw-scons.tar.bz2:
#:<pre>wget http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2</pre>
#Untar the libraries:
#:<pre>tar -xjf glob2_required_libs_mingw-scons.tar.bz2</pre>
#Download glob2 sources from mercurial (check [[Compiling#Sources_from_Mercurial]] for details):
#:<pre>hg clone https://bitbucket.org/giszmo/glob2</pre>
#:<pre>cd glob2-new</pre>
#Compile:
#:<pre>scons -j5 mingwcross=yes</pre>
#To create NSIS installer package run after previous step:
#:<pre>scons -j5 mingwcross=yes dist</pre>

===Test globulation2 for Windows on Debian===

#Install wine:
#:<pre>sudo apt-get install wine</pre>
#Copy files necessary to run:
#:<pre>cp src/glob2.exe .</pre>
#:<pre>cp ../local/bin/* ../local/lib/* .</pre>
#Run glob2:
#:<pre>wine glob2.exe</pre>

[[Category:en]]
[[Category:Developer Resources]]

Mercurial

2012-10-04T19:28:33Z

Giszmo: hg.globulation2.org was broken. https://bitbucket.org/giszmo/glob2 from now on is the "main" repository.

{{UserManualLinks}}

== Browsing the Project Repository ==
At https://bitbucket.org/giszmo/glob2 you can browse through the repository.

== Tools ==
;hg: To really access a mercurial repository you need mercurial. You can get it from your distribution if you are running Linux or from [http://www.selenic.com/mercurial the mercurial homepage]. An in depth manual of hg you can find [http://hgbook.red-bean.com/read/ here].
;tortoise-hg: To generally access hg repositories at a file system level you might want to use a GUI. [http://tortoisehg.bitbucket.org/ Tortoise-HG] is just great for that.
;HGE: The mercurial plugin for Eclipse is another great way to navigate our repository. You need Eclipse (the CDT-version) and can then get HGE by going to help -> install new software... -> Add... -> Location = http://cbes.javaforge.com/update -> checking mercurial eclipse ...

== Getting a Copy of the Mercurial Repository ==
No matter if you want to contribute with write access or just want to get a read only copy of glob2, you should cd to a directory where you have write permissions and run hg clone:
cd ~/my_hg_repositories
hg clone https://bitbucket.org/giszmo/glob2
cd glob2
The same can be achieved using HGE or tortoise-HG.

== Which revision to use ==
Having cloned the repository you now have all the history of glob2 at hands. According to your intents you now might want to choose different revisions to jump to and start working on them. Pick from the subsections what most fits your intents:

=== The player ===
If you want to play against others you need the same '''major''' version of glob2 as they have. If they have betaX.4 you should pick some betaX version. You get the latest version in the betaX release candidate branch using the tip of betaX-rc. To get there issue
hg update betaX-rc

In rare occasions this version might not work. To get a version that was tagged for being released, check the output of
hg tags
for lines matching betaX.y and update to the highest y:
hg update betaX.y

=== The tester ===
If you want to test the latest not yet released version of glob2 you should update to the tip of the latest release candidate (-rc) branch:
hg update betaY-rc
or if a feature freeze was not yet decided on, you can also test the latest version of the default branch:
hg update default

=== The bug fixer ===
You might have started as a tester but now want to actually touch code. Now it is getting slightly more complicated. Having found a bug and a solution to it means applying the fix to the right revision. As bugs often are not only bugs of not yet released features but also express in years old versions you should fix the oldest relevant version. If on the download page beta4 is still promoted, you should fix this and merge your changes up to beta5 and finally to default. In hg this is pretty easy to do:
hg update beta4-rc
do your changes to the code ....
hg commit -m"fixed bug xy ..."
hg update beta5-rc
hg merge beta4-rc
hg commit -m"merge"
hg update default
hg merge beta5-rc
hg commit -m"merge"
Depending on how important the bug-fix was you might now want to directly tag the new versions:
hg tag beta4-rc beta4.X
hg tag beta5-rc beta5.Y

=== The mini-features guy ===
If you have a new small feature to contribute, you do this in "default":
hg update default
do your changes to the code ...
hg commit -m"implemented mini-feature xy"

=== The big-features guy ===
If you have a new big feature to contribute, you do this in a separate branch starting at "default":
hg update default
hg branch fooFeature
work on your feature with a series of
change code
hg commit -m"changed this and that"
but while you work on your feature don't miss to get in sync with the changing "default" by doing as follows:
hg pull
hg merge -r default
hg commit -m"merge"
once your feature is ready to be used in the game just like other features, merge it into default:
hg update default
hg merge fooFeature
hg commit -m"merged"

== Publishing changes ==
All the above was read only from the point of view of the main glob2-repository. If you have changes worth sharing you must make them public. Easiest is to pick one of the free mercurial hosters. If you go for [https://bitbucket.org bit bucket] you can fork [[User:Giszmo|Giszmo]]'s [https://bitbucket.org/giszmo/glob2 repository].
With your own bitbucket setup you can check for what would push
hg outgoing https://bitbucket.org/yourBBNick/glob2
and push your changes there:
hg push https://bitbucket.org/yourBBNick/glob2

Now after you checked all is fine you can ask on the glob2 mailing list for someone with write access to the main repo to pull your changes. Asking on the irc is an option, too but for bigger changes you review might take some time and then it is safer to do it via the mailing list.

Don't forget to change the authors file if it's your first contribution ;)

If you are a regular contributor you may get write permissions for the central repo from [[User:Nct|Nct]]. You can mail him your username and password at stephane [at] magnenat [dot] net.

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

User talk:Zwarn

2012-07-02T05:19:58Z

Giszmo: Created page with "Hi, I have no clue why '''I''' created the German version of your user page, but if anything, this would belong to your namespace. --~~~~"

Hi, I have no clue why '''I''' created the German version of your user page, but if anything, this would belong to [[User:Zwarn/de|your namespace]]. --[[User:Giszmo|Giszmo]] ([[User talk:Giszmo|talk]]) 05:19, 2 July 2012 (UTC)

User:Zwarn/de

2012-07-02T05:15:40Z

Giszmo: user page translation in user's namespace

Ich mag das Spiel und würde gerne helfen es (und diese Seite) zu übersetzen.

Und zwar solange, bis nirgendwo mehr der Verweis "(englisch)" stehen muss!

CodingConventions

2012-07-02T04:48:31Z

Giszmo:

==Coding Conventions==

This page lists the coding conventions actually in use within Glob2. The intended purpose is to have coherent-looking code through the project. Sorry if this different to your usual conventions.

=== KISS: Keep it Simple Stupid ===
All new code written in Glob2 should be obvious. Don't use clever tricks. Everything should be kept as simple as possible, but no simpler. This is a fundamental principle, and all new code should be kept with KISS in mind.

=== Maintainability Is God ===
If code is readable, if its maintainable, then it is good. Sometimes people get haggled about using pure OO or get/set. Make sure that your code is maintainable. If you change one portion, always try to minimize the amount of other code segments that need updated. This encompasses many techniques. Encapsulation is one of the best.

===Indentation===

Code should be indented by tabs. A tab should be equivalent to 4 spaces. Please note that in the code below, non-breaking spaces are used because tabs don't display correctly in web pages.

===Class and struct naming===

Classes should begin with capitals, new words should be denoted by a capital, and words should not be separated by underscores or dashes. In other words,

class TotoIsMyFriend { }; // correct

instead of:

class toto_is_my_friend{}; // wrong

Class members, variables, and C function follow the same convention but without the initial capital:

void totoIsMyFriend(void); // correct

instead of:

void Toto-is-my-friend(void); // wrong

===Bracket placement===

Brackets {} should be placed alone on a line, except if there is no or only one function call within them.

class Toto
{
    int i;
    void totoIsMyFriend(void) { return i; };
}; // correct

instead of:

class Toto {
    int i;
    void Toto-is-my-friend(void) {
        return i;
    };
}; // wrong

===Emacs===

If you use Emacs as your editor, you can make it apply these rules to Globulation 2 files by putting the following in the .emacs file in your home directory:

(defconst glob2-c-style
'((c-basic-offset . 4)
(c-offsets-alist . ((substatement-open . 0)
(inline-open . 0)
))
)
"Globulation 2 programming style")

;; Customizations for all modes in CC Mode.
(defun glob2-c-mode-common-hook ()
(c-add-style "glob2" glob2-c-style)
)

(add-hook 'c-mode-common-hook 'glob2-c-mode-common-hook)

And adding the following to the top line of each of your source files:

/* emacs settings information: -*- mode: c++; tab-width: 4; c-file-style: "glob2"; -*- */

==Proposed Conventions==

This section discusses proposals for programming style rules that have not yet been widely accepted

===Counting===

When referring to the total number of items of a particular type that there are, the current rule is to use <code>numberOfFoo</code>. I find this confusing, as I expect <code>numberOfFoo</code> to refer to the index number of a particular instance of foo. Some alternatives include:

* <code>fooCount</code>
* <code>fooTotal</code>
* <code>fooSize</code>

<code>fooCount</code> seems the easiest to read of the three, <code>fooTotal</code> also makes sense, and <code>fooSize</code>, while confusing, mirrors the <code>foo.size()</code> convention used in STL containers.

By extension, where there is an ordered list of things (most likely an enum), we should always have the following definitions:

enum foo { foo1, foo2, ... fooN };
static const int fooMin = foo1;
static const int fooMax = fooN;
static const int fooCount = fooMax - fooMin + 1;

===Getting and setting===

At present, it's standard to get values with <code>getFoo()</code> and set them with <code>setFoo(value)</code>. While this is clear, it doesn't fit with the C++ convention of using <code>foo()</code> and <code>foo(value)</code>. It also doesn't distinguish between the cases where we are supposed to think of <code>getFoo()</code> and <code>setFoo()</code> as simple wrappers around private variables vs. where we should expect more significant processing to be done. I propose that we use <code>getFoo()</code> only where the user should expect significant processing to be done. For example, <code>GAGCore::getFilename()</code> searches an entire list of directories for a file, whereas <code>debugLevel()</code> just sets an internal variable.

=== documentation ===
When doing documentation, a comment section for a function should look something like this:

<pre>
/**
* Any comments go here
* @param string $foo
* @param int $bar
* @return boolean
* @access private
* @todo document
*/
</pre>

keep in mind not all of these items are always needed. if it doesn't take any parameters, that section is not needed. 
so if it doesn't take any parameters, you can leave @param out

[[Category:en]]
[[Category:Developer Resources]]

Main Page

2012-07-02T04:40:26Z

Giszmo: removed all "news" that were more than 12 years old

{{Translations|Watch page in|Article=Main_Page}}

<div style="float: right; margin: 10px 0px 10px 20px;">[[Image:Alpha23-attack.jpg|200px]]</div>
Globulation 2 is an innovative Real-Time Strategy (RTS) game which reduces micro-management by automatically assigning tasks to units. Take a look at the [[Screenshots|screenshots]] or just [[Download and Install|download]] and try it right now. Globulation 2 is Free Software, licensed and distributed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License].

Globulation 2 brings a new type of gameplay to RTS games. The player chooses the number of units to assign to various tasks, and the units do their best to satisfy the requests. This allows players to manage more units and focus on strategy rather than on micro-management. Globulation 2 also [[AI|features AI]], allowing single-player games or any possible combination of human-computer teams. The game also includes a [[Map_editor_guide|scripting language]] for versatile gameplay or tutorials and an integrated [[Map_editor_guide|map editor]]. You can play Globulation 2 in single player mode, through your local network, or over the Internet with [[YOG|Ysagoon Online Gaming]] (or ''YOG'' for short). -- [[Team|Globulation 2 team]]

<div style="text-align:left;">Note : the wiki and forums have the same usernames and passwords.</div>
{|valign="top" cellpadding="10"
|valign="top" style="width:49%;"|
== You Can Help! ==
Globulation 2 isn't just a bunch of code - it needs artwork, playable maps, campaigns and tutorials, sound effects and documentation to make a fun game. If you want to see your name in Globulation 2's credits, jump right in!

;[[Players]]: The more Players, the more fun in Globulation 2 online games.
;Programmer: There's a wide variety of topics that need contribution. You name it - we need it. If you want to program right away, you can do so by forking this code for example at [http://bitbucket.org/giszmo/glob2 BitBucket] and ask for a merge once you think it is worth merging ;)
;Map and Campaign Designer: To give the game a good selection of maps, and a new, longer, in depth campaign
;2D and 3D Artist: To add campaign specific units, to do an opening cinematic.
;[[SoundFX|Sound Artist]]: To do in game sound effects for events like attacking, moving, ...
;Tester: The more testers; the better gameplay and the less bugs.
;Documenter: We always welcome people who can write documentation on playing the game, to go along with the tutorial
;Translators: We are also always in need of people who can translate the in game texts to new languages or maintain existing translations.

Should you be interested, the first steps would be to have a look on the [http://www.globulation2.org/forums forums], join the [https://savannah.nongnu.org/mail/?group=glob2 development Mailing list], drop into the developers' [[IRC]] channel (#glob2-dev and #glob2 on irc.globulation2.org) and look around this site.

You also can help by simply '''telling your friends about Globulation 2''' or inform us of any game reporting site that does not list Globulation 2.
|valign="top" style="width:2%;"|
|valign="top" style="width:49%;"|
== News ==
;30.06.2012 : Forum and wiki has been moved to [[User:ProgVal|ProgVal]]'s server.

:More news in the [[News Archive|news archive]]
|}


__NOEDITSECTION__
__NOTOC__

News Archive

2012-07-02T04:39:20Z

Giszmo:

== Old News ==

;25.05.2009 : [[Players]] started the '''first [[Tournament]]''' since beta status.
;25.03.2009 : Beta 4 0.9.4.1 has been released. This fixes the corrupt Tutorial 3 in Beta 4. [[Download_and_Install|download page]].
;02.02.2009 : Beta 4 has been released. Check out the new release on [[Download_and_Install|download page]].
;24.04.2008 : Beta 3 has been released. Check out the new release on [[Download_and_Install|download page]].
;07.04.2008 : After a short down time we are back online on the server of [[User:Giszmo|Giszmo]]. If you experience bad performance, please let us know via [[IRC]], [https://savannah.nongnu.org/mail/?group=glob2 Mailing List], posts to [[Talk:Main_Page]] or via the [http://www.globulation2.org/forums forum].
;20.03.2008 : The [[Download and Install]] page has been redone, and the compiling instructions have been split into a [[Compiling]] section, which dramatically improves the pages usability.
;03.03.2008 : Globulation 2 was present at [http://www.fosdem.org/2008/schedule/events/globulation http://www.globulation2.org/wiki/images/a/ae/Fosdem08.png]. The presentation is available at [http://stephane.magnenat.net/data/glob2-fosdem2008-presentation.pdf here]. A video of the presentation can be downloaded from [http://ftp.heanet.ie/mirrors/fosdem-video/2008/maintracks/FOSDEM2008-globulation2.ogg here].
;23.02.2008 : Beta 2 has been released. Check out the new release on [[Download_and_Install|download page]].
;20.02.2008 : The wiki and forums have finally been brought up to date! Unfortunately the passwords for the forum couldn't be salvaged so you have to create a new password, and the glob2 theme hasn't been fully recreated yet.

==Old Game News==

*01.09.2007  -  Beta1 released
*18.04.2007  -  Alpha23 released
*03.04.2007  -  Alpha22 released
*04.08.2006  -  Alpha21 released
*04.08.2006  -  Alpha20 released
*12.03.2006  -  Alpha19 released
*29.01.2006  -  Alpha18 released
*11.12.2005  -  Alpha17 released
*04.12.2005  -  Alpha16 released
*15.05.2005  -  Alpha15 released
*24.04.2005  -  Alpha14 released
*16.04.2005  -  Alpha13 released
*13.02.2005  -  Alpha12 released
*16.01.2005  -  Alpha11 released
*29.12.2004  -  Alpha10 released
*08.10.2004  -  Alpha9 released
*12.09.2004  -  Alpha8 released
*08.08.2004  -  Alpha7 released
*09.06.2004  -  Alpha6 released
*30.03.2004  -  Alpha5 released
*20.03.2004  -  Alpha4 released
*08.02.2004  -  Alpha3 released
*08.02.2004  -  Alpha2 released
*01.02.2004  -  Alpha1 released

==Old Website News==
*22.04.2007  -  The front page was spammed. The spammer ''very impressivly'' overwrote the main page with some links that said "HacKeD BY ..." on public wiki on an open source webpage, certainly not something any person could do. The changes where reverted and the admin has banned the spammer.
*22.04.2007  -   Globulation 2 has moved its source code from [[CVS]] to [[Mercurial]]. If you are a contributor, please learn about and commit to [[Mercurial]] from now on. We have updated the wiki to reflect these changes. The last things to do are to change the translated pages (page in a language other than English), and the bot that updates the [[Team]] page when the AUTHORS files is changed.
*15.04.2007  -  [[Bug day 20070414]] went ok, but hopefully next time we can have more participants. That shouldn't stop you from submitting regular [[Bug Reports]] though.
*4.03.2007  -  The website is back online! [[2007-03-04_prolonged_downtime | click here for more details]]
*27.11.2006  -  The server experienced 14 hours of downtime due to a hard drive failure, but everything is back up and running just fine now! [[User:AppleBoy|AppleBoy]]
*17.08.2006  -  the forum code has been updated by [[user:Ion bidon|Ion bidon]] and myself to clean out spam and deter spam-bots from being able to register. please give us feedback, and if you're account was deleted please let me know (I'm sorry about that) [[User:AppleBoy|AppleBoy]]
*18.06.2006  -  mediawiki has been upgraded to the latest version (1.6.7). Please report any problems to [[User:Ion bidon|Ion bidon]].
*18.06.2006  -  Email addresses *@mail.ru and *@cachette.com have been banned due to spam.
*14.06.2006  -  The forums have been upgraded. Please report any problems to [[User:Ion bidon|Ion bidon]].
*12.02.2006  -  [[User:Glob2bot|Glob2bot]] is a bot created to update the [[Team]] page from the [http://cvs.savannah.nongnu.org/viewcvs/glob2/glob2/AUTHORS?view=markup CVS AUTHORS file]
*30.12.2005  -  [http://glob2.ysagoon.com glob2.ysagoon.com] and [http://forum.ysagoon.com forum.ysagoon.com] now redirect to here.
*19.12.2005  -  Small bugs fixed on the phpbb/mediawiki users integrations.
*16.12.2005  -  The custom theme has been updated.
*12.12.2005  -  The wiki now has a customized theme.
*11.12.2005  -  http://www.globulation2.org/ is now considered the main homepage for Globulation 2. The old site should be quickly incorporated into this one.
*05.12.2005  -  The mediawiki/phpbb users integration is now finished. From now on, each person has the same account on both mediawiki and the forum. You need only to register once (mediawiki or phpbb). You can access the forums with the link "players forums" on the left.
*01.12.2005  -  New server online, will be http://www.globulation2.org/
*11.03.2005  -  Server has been moved in new room with air-conditioning and is back online.
*10.10.2004  -  The wiki documentation has been cleaned up
*26.02.2004  -  Small web update, french translation updated.
*18.01.2004  -  Forum installed.
*18.01.2004  -  Engine rework completed. Network fixed. YOG is up. Now the game needs tuning and graphics for the 1.0 release.

[[Category:en]]
[[Category:Archives]]

CodingConventions

2012-07-02T04:20:43Z

Giszmo: integrated Code Documentation

==Coding Conventions==

This page lists the coding conventions actually in use within Glob2. The intended purpose is to have coherent-looking code through the project. Sorry if this different to your usual conventions.

=== KISS: Keep it Simple Stupid ===
All new code written in Glob2 should be obvious. Don't use clever tricks. Everything should be kept as simple as possible, but no simpler. This is a fundamental principle, and all new code should be kept with KISS in mind.

=== Maintainability Is God ===
If code is readable, if its maintainable, then it is good. Sometimes people get haggled about using pure OO or get/set. Make sure that your code is maintainable. If you change one portion, always try to minimize the amount of other code segments that need updated. This encompasses many techniques. Encapsulation is one of the best.

===Indentation===

Code should be indented by tabs. A tab should be equivalent to 4 spaces. Please note that in the code below, non-breaking spaces are used because tabs don't display correctly in web pages.

===Class and struct naming===

Classes should begin with capitals, new words should be denoted by a capital, and words should not be separated by underscores or dashes. In other words,

class TotoIsMyFriend { }; // correct

instead of:

class toto_is_my_friend{}; // wrong

Class members, variables, and C function follow the same convention but without the initial capital:

void totoIsMyFriend(void); // correct

instead of:

void Toto-is-my-friend(void); // wrong

===Bracket placement===

Brackets {} should be placed alone on a line, except if there is no or only one function call within them.

class Toto
{
    int i;
    void totoIsMyFriend(void) { return i; };
}; // correct

instead of:

class Toto {
    int i;
    void Toto-is-my-friend(void) {
        return i;
    };
}; // wrong

===Emacs===

If you use Emacs as your editor, you can make it apply these rules to Globulation 2 files by putting the following in the .emacs file in your home directory:

(defconst glob2-c-style
'((c-basic-offset . 4)
(c-offsets-alist . ((substatement-open . 0)
(inline-open . 0)
))
)
"Globulation 2 programming style")

;; Customizations for all modes in CC Mode.
(defun glob2-c-mode-common-hook ()
(c-add-style "glob2" glob2-c-style)
)

(add-hook 'c-mode-common-hook 'glob2-c-mode-common-hook)

And adding the following to the top line of each of your source files:

/* emacs settings information: -*- mode: c++; tab-width: 4; c-file-style: "glob2"; -*- */

==Proposed Conventions==

This section discusses proposals for programming style rules that have not yet been widely accepted

===Counting===

When referring to the total number of items of a particular type that there are, the current rule is to use <code>numberOfFoo</code>. I find this confusing, as I expect <code>numberOfFoo</code> to refer to the index number of a particular instance of foo. Some alternatives include:

* <code>fooCount</code>
* <code>fooTotal</code>
* <code>fooSize</code>

<code>fooCount</code> seems the easiest to read of the three, <code>fooTotal</code> also makes sense, and <code>fooSize</code>, while confusing, mirrors the <code>foo.size()</code> convention used in STL containers.

By extension, where there is an ordered list of things (most likely an enum), we should always have the following definitions:

enum foo { foo1, foo2, ... fooN };
static const int fooMin = foo1;
static const int fooMax = fooN;
static const int fooCount = fooMax - fooMin + 1;

===Getting and setting===

At present, it's standard to get values with <code>getFoo()</code> and set them with <code>setFoo(value)</code>. While this is clear, it doesn't fit with the C++ convention of using <code>foo()</code> and <code>foo(value)</code>. It also doesn't distinguish between the cases where we are supposed to think of <code>getFoo()</code> and <code>setFoo()</code> as simple wrappers around private variables vs. where we should expect more significant processing to be done. I propose that we use <code>getFoo()</code> only where the user should expect significant processing to be done. For example, <code>GAGCore::getFilename()</code> searches an entire list of directories for a file, whereas <code>debugLevel()</code> just sets an internal variable.

= documentation =
When doing documentation, a comment section for a function should look something like this:

<pre>
/**
* Any comments go here
* @param string $foo
* @param int $bar
* @return boolean
* @access private
* @todo document
*/
</pre>

keep in mind not all of these items are always needed. if it doesn't take any parameters, that section is not needed. 
so if it doesn't take any parameters, you can leave @param out

[[Category:en]]
[[Category:Developer Resources]]

Talk:Beta 5 rebalance

2012-07-02T02:58:40Z

Giszmo: Created page with "Does this belong into the wiki? looks more like a mailing list thing. --~~~~"

Does this belong into the wiki? looks more like a mailing list thing. --[[User:Giszmo|Giszmo]] ([[User talk:Giszmo|talk]]) 02:58, 2 July 2012 (UTC)

Talk:Download and Install

2011-01-26T16:24:55Z

Giszmo: Reverted edits by Meganag (Talk); changed back to last version by PeEll

==Ubuntu/Debian Packages Missing==
Is it just me, or are the debian packages missing right now? I get a german 404 error.
[[User:PeEll|PeEll]] 07:55, 5 April 2009 (CEST)

==Open wiki for software distribution ?==
Security Note: This is all it takes to edit something like this? You guys shouldn't have a completely open wiki for software distribution... - Me
:If I understand correctly, the wiki is open while the transfer from the old wiki takes place. When finished, new registrations should probably be closed from the public. However, when you think about it, if someone makes an edit that links to say a virus, all someone has to do is delete that edit. Unfortunatly, Globulation 2 isn't big enough for that to happen instantly :( It would take about a day for someone to realise. - k776
::The idea of an open wiki is very good and people can contribute very easily if they want to. Some of us are watching for modifications in order to keep the wiki clean from vandalism. If we will have problems in the future, we may change the "open" status. But until now, we had no problems. - [[User:Ion bidon|Ion bidon]] 16:01, 9 February 2006 (PST)

I think we should not expand too much the instructions about each distributions. Instead, I think we should cleanly list what we provide and list distributios that alos provide glob2, by saying perhaps versions are outdated. For distribution-specific installation, we can link distribution's documentations. - [[User:nct|Steph]]

I suggest we have 2 separate pages : A Download page and a Install_Glob2 page for example, the [[Download_and_Install]] page contains too much infos. - [[User:Ion bidon|Ion bidon]] 16:28, 19 December 2005 (PST)

:Well, I was thinking that we should just provide quick install help in the download section, but if you think that it's better to have a separate install guide, let's make a good one and put it in the left menu. - [[User:Nct|Nct]] 07:26, 20 December 2005 (PST)
::I agree to provide a quick install help in the download section, but a separate install guide is very good. I will see what I can do about it. - [[User:Ion bidon|Ion bidon]] 07:44, 20 December 2005 (PST)

== No Mac OS X download?==

There is no link to the DMG mentioned in the Mac OS X installer instructions. Also, FYI, software installation SOP on Mac OS X is typically "drag the application (a folder in disguise) from the disk image to your Applications directory (or really, anywhere you want.)" Though perhaps the installer installs other things in other places… --[[User:DonnyViszneki|DonnyViszneki]] 03:06, 11 July 2006 (PDT)

--Pmol--
Check out http://glob2.darwinports.com/ :)

This doesn't fix the problem of the wiki referring to a downloadable DMG disk image. You CAN install Globulation 2 via DarwinPorts, however the install isn't ''nice'' for average users who just want to click and install. Either the instructions in the wiki need to change to reflect this, or a DMG should be made available.

Problems with what the wiki says:

''Mount the disk image file, and start the installer from it.''

There's no link to the DMG. Users cannot get the DMG. Users cannot 'start the installer'.

''Globulation gets installed in /Applications/Globulation2.''

Using DarwinPorts, the game is installed in /opt/local/bin/... etc.

''To run the game, open /Applications/Globulation2/Globulation2.''

IF DarwinPorts is set up properly (path is correct), the user starts Globulation 2 by typing glob2 at the terminal prompt.

Unless a Mac OS X user is determined enough, they probably are not going to try out Globulation 2.

--[[User:Juicymixx|Juicymixx]] 06:42, 10 November 2006 (PST)

== Reduce redundancy ==

As all packages are linked at least twice we risk to have different versions through the link in "latest release" and in "install under xyz". I suggest to link to the binaries only once (latest release) and link to "latest release" from everywhere else.

to even further reduce redundancy (p.e. through translations) we should only link to some folder with a hirarchy of version/platform/files. this way even if the link talks about version .16 the end user will still download the latest.

== unofficial cvs-windows-binary ==

i removed the broken link by commenting it out.

MediaWiki:Roundedblue2.css

2011-01-05T02:40:58Z

Giszmo:

#bodyContent {background-color: blue;}

MediaWiki:Roundedblue2.css

2011-01-05T02:07:35Z

Giszmo: New page: body {background-color: blue;}

body {background-color: blue;}

Media guide

2010-12-28T13:32:13Z

Giszmo: Undo revision 5711 by TinaBole (Talk)

TODO - explain how people can contribute artworks:
* How to modify the images used by the game (images must be placed into a specific directory - FIXME) [[Tileset_handbook|Tileset handbook]]
* How to make sounds for the game (the game does not support yet sounds events)
* How to create musics for the game. It can play diferent types of music depending ont the state (under atack, at peace, buildings are constructed...)

[[Category:en]]
[[Category:Contributor Resources]]

Template:Translations

2010-12-28T13:27:39Z

Giszmo:

<table id="language-bar" style="padding:0; margin: auto;" cellpadding="0" cellspacing="0"><tr><td align="center">
[[{{{Article}}}|English]] |
[[Fr:{{{Article}}}|Français]] |
[[De:{{{Article}}}|Deutsch]] |
[[Es:{{{Article}}}|Español]] |
[[It:{{{Article}}}|Italiano]] |
[[Cs:{{{Article}}}|Česky]] |
[[Ro:{{{Article}}}|Română]] |
[[Ru:{{{Article}}}|Русский]] |
[[Ca:{{{Article}}}|Català]] |
[[Fi:{{{Article}}}|Suomi]] |
[[Ja:{{{Article}}}|Japanese]] |
[[Zh:{{{Article}}}|Chinese]]
</td></tr></table>

Template:Translations

2010-12-28T13:24:56Z

Giszmo:

Combat

2010-11-15T17:58:10Z

Giszmo: Undo revision 6205 by Oziveheribi (Talk)

{{UserManualLinks}}

==Combat description==
All units and buildings have a certain number of hit points. When a unit or building is attacked, it loses hit points based on the attacker's training and experience level, and based on the amount of armour it has. Units can also lose hit points through starvation.

Units die (and buildings are destroyed) if they completely run out of hit points. Damaged units can regain hit points by being healed in a hospital, buildings can regain hit points by being repaired.

The amount of damage done by an attacker is based on its basic damage, plus its experience level, minus the amount of armour the defender has. Although the principles are the same, different types of combateer attack in different ways:

* Warriors walk up to their enemies and hit them repeatedly. Their attack speed skill controls the number of blows they can land each second.
* defence towers throw rocks at nearby ground-based enemies. They take a long time to reload and need to be restocked with stone every so often.
* explorers perform a magic attack whenever an enemy gets within one square of it. At first, this attack only affects other explorers adjacent to it, but training in a level 3 school allows explorers to attack ground targets. The magic attack is incapable of damaging buildings but completely bypasses all armor. Explorers can attack once for every three moves they make.

==Managing combateers==

You can get information about individual units and buildings by clicking on them. The graphs? and statistics? menus also give an overview of how your population is doing.

==Armour==

Some units (and some buildings) are armoured against enemy attack. Each point of armour deflects one point of damage done by an attacker, although warriors and defence towers will always deal one point of damage no matter how much armour you have.

Warriors start off with 10 points of armour, minus 10 points for each piece of fruit they ate in the last inn they went to. A warrior that took two pieces of fruit with his last meal will have -10 armour, meaning that he takes 10 extra points of damage for every blow he is dealt. Armour lost due to fruit doesn't accumulate, so if the warrior eats no fruit the next time he takes lunch, he will go back to having 10 points of armour.

==Basic Damage==

Defence towers do a certain basic amount of damage based on the level they've been upgraded to. Level one towers do 30 points of basic damage, level two towers do 40 points, level three towers do 60 points.

Explorers' air damage is worth 8 basic points, as is their ground damage once they've learnt it.

A warrior's basic damage depends on its attack strength. Learning attack strength to level 1 gives it 8 basic points of damage. Learning it to level 2 gives 16 points, level 3 is gives 24 points, level 4 gives 32.

==Experience==

The more experience a unit has of combat, the stronger he gets. Units start off with no experience, and gain one experience point ("XP") for every point of damage they do to an enemy (after armour is taken into account). Eventually, they will get enough XP to go up to the next level of experience, which means that every blow they land in combat does another point of damage. As they go up a level, their new level is shown in yellow next to them for a moment.

For convenience, here is a list of experience levels - in practice, it's very rare to get above experience level 10.

{| width="100%"
|
{| border="1" cellpadding="2" align="center"
|+'''Warrior experience levels''' :
|-
! Experience level !! XP needed !! Cumulative XP
|-
| 0 || 0 || 0
|-
| 1 || 20 || 20
|-
| 2 || 80 || 100
|-
| 3 || 180 || 280
|-
| 4 || 320 || 600
|-
| 5 || 500 || 1100
|-
| 6 || 720 || 1820
|-
| 7 || 980 || 2800
|-
| 8 || 1280 || 4080
|-
| 9 || 1620 || 5700
|-
| 10 || 2000 || 7700
|}
|
{| border="1" cellpadding="2" align="center"
|+'''Explorer experience levels''' :
|-
! Experience level !! XP needed !! Cumulative XP
|-
| 0 || 0 || 0
|-
| 1 || 50 || 50
|-
| 2 || 200 || 250
|-
| 3 || 450 || 700
|-
| 4 || 800 || 1500
|-
| 5 || 1250 || 2750
|-
| 6 || 1800 || 4550
|-
| 7 || 2450 || 7000
|-
| 8 || 3200 || 10200
|-
| 9 || 4050 || 14250
|-
| 10 || 5000 || 19250
|}
|}

===Details of the experience system===

The details of the experience system are given here, but if you're not interested in numbers, this section can be safely skipped.

The formula for working out the number of XP needed to advance from one level to the next is cl2 where l is the level you want to get to, and c is a constant based on your unit type (20 for warriors, 50 for explorers). Experience gained getting to one level doesn't count towards the experience you need to get to the next, so the total amount of experience you need to get to a particilar experience level n is the sum of cl2 from l=1 to l=n.

==Getting into a fight==

Explorers won't attack unless they fly directly into (or over) an enemy unit. Defence towers will attack any enemy unit or building that comes into its firing range. Warriors will attack any enemy they can see within an 8x8 square around them.

==Putting it all together: an example==

Note: This could be expanded and moved into the unit section later on.

A new warrior emerges from one swarm, a new explorer emerges from another. They each start with an experience level of 0 and 0 XP. They each deal 8 points of damage for every attack they do. They each take a moment to look around for things to do. The explorer sees nothing to do, so he begins to fly across the landscape to see what he can find. The warrior sees several barracks he could train in, and a war flag in the distance. He prefers the war flag, which he immediately heads toward.

Soon, the warrior finds himself in combat. He and three other warriors surround a market and start attacking it. Each blow he lands should do 8 points of damage, but the market deflects 2 points with its armour. After he hits the market four times, he has done 24 points of damage and gained 24 experience, so he gains an experience level. Now, each blow he lands does 9 points of damage, minus 2 because of armour. The warrior gets three more blows in before his team-mates destroy the market. As the warrior retires to a nearby inn for lunch, he has 1 experience level and is 25 points towards reaching level 2.

In the mean-time, the explorer happens upon an enemy explorer. The explorers fight, dealing each other 8 points of damage for every blow they land. Luckily, the enemy explorer had previously lost a hit point through a moment's starvation, so dies after being dealt 24 points in 3 blows. Like the warrior, the explorer has gained 24 experience, but because he needs 50 experience points to go up a level, he remains at level 0. After the fight, the explorer has only one remaining hit point, so makes his way straight to the nearest hospital.

The warrior finishes his lunch and takes an orange, which takes his armour level from 10 down to 0. He looks again for something to do. There are no war flags any longer, although there is a guard area nearby. Most of the teams barracks are full with other warriors now, but there's space in a level two barracks, which he immediately signs up for.

As the warrior enters the barracks, the explorer leaves the hospital. Still not hungry, he looks for something to do. There is an exploration flag on the other side of the map that needs more explorers, which he heads for. But he gets hungry before he can make it there, so turns round and heads for an inn. After lunching at the inn, he sees a level 3 school with an empty place, so goes there to train.

The warrior leaves the barracks with an attack speed of 3, so now he will attack three times as quickly as before. There are now two guard posts - one nearby and one in the distance. He heads to the nearby one. Soon, two enemy warriors pass near the guard post. He goes to attack them, and it turns out neither of them have any experience, skill, or armour. They are no match for him, and he gains two experience levels fighting with them before they flee. The warrior gives chase, but they have a much higher walking speed, so they manage to escape. The warrior heads to hospital then to an inn.

When the explorer leaves the inn, he heads back toward the exploration flag set there before. When he arrives, he finds a group of 7 warriors marching to attack his base. He begins attacking the warriors which are unable to fight back. The enemy warriors choose to keep marching despite this and arrive at the base with only half their health. The 4 friendly warriors now fully healed also join the fight. Despite superior numbers the enemy units are defeated due to the damage taken from the explorer.

==Combat Strategy==

* Since warriors will only attack visible targets within a box 8 squares wide around them, paint guard areas so that units can't sneak past without being spotted, or run past taking only minimal damage.
* You can draw warriors into combat with war flags and explorers with exploration flags. However, you may want to try increasing the minimum experience level on your war flags so that you have enough troops to do the job, but weaker warriors stay at home to train.
* Gaining experience is good, but training is better. Destroy war flags as quickly as possible, so that your warriors have time to train between battles. Well-trained warriors tend to gain experience levels faster anyway.
* Keep an eye on the wound graph?. If the amount of wounding rises briefly, it may mean your units are under attack. If it continues to rise (or remains constant) for a long time, you need more hospitals.
* At the start of the game, warriors will have more armour than attack strength, so are almost invulnerable to each other. During this period, you might want to harrass your enemies with small attack parties that simply retreat when faced with significant opposition. However, as barracks are set up and globs start eating fruit, fighting gets more dangerous for warriors - so it becomes important to go into combat with more, better trained, warriors than your enemy.
* Defence towers are quite useful early in the game, as they have enough armour to defend themselves against warriors and do enough damage to get past the warrior's armour. However, it can take the entire capacity of one defence tower to see off a warrior, so you will need a string of towers (or a secure supply line) to defend against any real enemy attack.
* As the game progresses, Defence towers become increasingly vulnerable to enemy attack, but upgraded defence towers can become useful when workers try to steal resources - a level 3 defence tower can kill a worker in four shots.
* If nothing else, defence towers can be a good first line of defence, letting you see the size of the enemy force, softening them up and keeping them busy while your own warriors are on their way to the battle.

[[Category:en]]
[[Category:User Manual]]

Compiling

2010-11-15T17:55:48Z

Giszmo: Undo revision 6203 by Oziveheribi (Talk)

{{UserManualLinks}}

__TOC__

{{Message|Compiling on Windows|The instructions below will not work for Windows. To compile on that OS, please see the [[Mingw compilation]] guide, which explains how to compile globulation2 on windows using mingw.}}

==Compilation requirements==
{{Message|Compiling on Mac OSX|There is an easier way to get all the dependancies than to compile them all. See the [[MAC OS X Development]] page for more information.}}
For source tarbal, Mercurial source, and package installations, you'll also need to install these packages:
* [http://www.scons.org/ scons] build system
* [http://www.libsdl.org/index.php SDL 1.2] download SDL-devel and SDL
* [http://www.libsdl.org/projects/SDL_net/ SDL_net 1.2] download SDL_net-devel
* [http://www.libsdl.org/projects/SDL_image/ SDL_image 1.2] download SDL_image-devel
* [http://www.libsdl.org/projects/SDL_ttf/ SDL_ttf 2.0] download SDL_ttf-devel
* [http://www.speex.org speex] download current stable release
* [http://www.xiph.org/ libogg and libvorbis] can be found in their download-section. libspeex, too.
* [http://zlib.net/ zlib]
* [http://boost.org/ Boost C++ Libraries] download boost, boost-devel, including boost_thread and boost_date_time.
* (optional) [http://fribidi.org/ Fribidi] download GNU FriBidi

===Debian/Ubuntu===
The following terminal command will get you all the dependencies:
sudo apt-get install scons libsdl1.2-dev libsdl-net1.2-dev libsdl-image1.2-dev \
libsdl-ttf2.0-dev zlib-bin libspeex-dev libogg-dev libvorbis-dev libboost-dev \
libboost-thread1.40-dev libboost-date-time1.40-dev
* Adding 'mercurial' to that line will get you all you need to get involved.

== Compile from Sources ==
=== Source Distribution ===
* Get the [[Download and Install|source distribution archive]] from the download section.
* Extract the archive using a compression/extraction utility such as tar.
* Go in the extracted archive. If you have a Unix system (GNU/Linux, Solaris, Mac OS X):
** Run the 'scons' script to compile the game (it will check dependencies, install any you have missing)
*** If you want to install the game in a special place, instead of 'scons', type:
scons BINDIR="/path/to/install/bin" INSTALLDIR="/path/to/install/share"
** Install with a simple 'scons install' command (will install to the location you might have entered when compiling (BINDIR and INSTALLDIR)).
** Run the game by typing 'glob2'. If it doesn't work, type '/path/to/install/bin/glob2' instead.
** Note: in some GNU/+Linux distributions (eg: Archlinux), scons complains about not finding -lboost_thread (with boost already installed). A solution is to modify the SConstruct file to look for boost_thread-mt instead of boost_thread, and the modify the LIBS variable with boost_thread-mt, to link against this library. If you have root access you can create a symlink libboost_thread.so instead.

=== Sources from [[Mercurial]] ===
{{Message|Warning|The source from Mercurial is occasionally unstable and will break. It is not meant for playing games but only for development and testing.}}
==== The quick way ====
Use this if you want to get exactly one copy of glob2 repository to compile and run it. This is also the recommended way if you are sure you will not want to push only parts of your changes.
* Initial download
cd some_workspace_directory
hg clone http://hg.globulation2.org/glob2-new/
* Subsequent updates
cd glob2-new
hg pull
hg update
: '''pull''' will get all changes from the original repository into your repository
: '''update''' will get your local files to the latest revision. Use '''-C''' to loose all local changes.
==== The more complicated way ====
Use this if you want to commit several changes that you are not sure of being finished some day while at the same time you want to have access to a clean checkout, too.
* Initial download
cd some_workspace_directory
hg clone http://hg.globulation2.org/glob2-new/
* clone to a working directory
cd some_workspace_directory
hg clone glob2-new glob2-work
* Subsequent updates
cd glob2-new
hg pull
cd ../glob2-work
hg pull
hg update
: '''pull''' will get all changes from the original repository into your target repository
: '''update''' will get your files to the latest revision. Use '''-C''' to loose all local changes.

* Read the README.hg and README files.
* Continue by following the [[#Source_Distribution|''source distribution'']] instructions from the 3rd step onwards.

[[Category:en]]
[[Category:User Manual]]

SoundFOX

2010-11-15T17:50:31Z

Giszmo: Undo revision 6206 by Oziveheribi (Talk)

No results yet. Please see the [[Talk:SoundFX|Talk-Page]] to this article.

[[Category:Developer_Resources]]

Mercurial

2010-08-21T23:40:08Z

Giszmo: /* Tools */

{{UserManualLinks}}

== Browsing the Project Repository ==
At http://hg.globulation2.org/ you can browse through the repository.

== Tools ==
;hg: To really access a mercurial repository you need mercurial. You can get it from your distribution if you are running Linux or from [http://www.selenic.com/mercurial the mercurial homepage]. An in depth manual of hg you can find [http://hgbook.red-bean.com/read/ here].
;tortoise-hg: To generally access hg repositories at a file system level you might want to use a GUI. [http://tortoisehg.bitbucket.org/ Tortoise-HG] is just great for that.
;HGE: The mercurial plugin for Eclipse is another great way to navigate our repository. You need Eclipse (the CDT-version) and can then get HGE by going to help -> install new software... -> Add... -> Location = http://cbes.javaforge.com/update -> checking mercurial eclipse ...

== Getting a Copy of the Mercurial Repository ==
No matter if you want to contribute with write access or just want to get a read only copy of glob2, you should cd to a directory where you have write permissions and run hg clone:
cd ~/my_hg_repositories
hg clone http://hg.globulation2.org/glob2-new glob2
cd glob2
The same can be achieved using HGE or tortoise-HG.

== Which revision to use ==
Having cloned the repository you now have all the history of glob2 at hands. According to your intents you now might want to choose different revisions to jump to and start working on them. Pick from the subsections what most fits your intents:

=== The player ===
If you want to play against others you need the same '''major''' version of glob2 as they have. If they have betaX.4 you should pick some betaX version. You get the latest version in the betaX release candidate branch using the tip of betaX-rc. To get there issue
hg update betaX-rc

In rare occasions this version might not work. To get a version that was tagged for being released, check the output of
hg tags
for lines matching betaX.y and update to the highest y:
hg update betaX.y

=== The tester ===
If you want to test the latest not yet released version of glob2 you should update to the tip of the latest release candidate (-rc) branch:
hg update betaY-rc
or if a feature freeze was not yet decided on, you can also test the latest version of the default branch:
hg update default

=== The bug fixer ===
You might have started as a tester but now want to actually touch code. Now it is getting slightly more complicated. Having found a bug and a solution to it means applying the fix to the right revision. As bugs often are not only bugs of not yet released features but also express in years old versions you should fix the oldest relevant version. If on the download page beta4 is still promoted, you should fix this and merge your changes up to beta5 and finally to default. In hg this is pretty easy to do:
hg update beta4-rc
do your changes to the code ....
hg commit -m"fixed bug xy ..."
hg update beta5-rc
hg merge beta4-rc
hg commit -m"merge"
hg update default
hg merge beta5-rc
hg commit -m"merge"
Depending on how important the bug-fix was you might now want to directly tag the new versions:
hg tag beta4-rc beta4.X
hg tag beta5-rc beta5.Y

=== The mini-features guy ===
If you have a new small feature to contribute, you do this in "default":
hg update default
do your changes to the code ...
hg commit -m"implemented mini-feature xy"

=== The big-features guy ===
If you have a new big feature to contribute, you do this in a separate branch starting at "default":
hg update default
hg branch fooFeature
work on your feature with a series of
change code
hg commit -m"changed this and that"
but while you work on your feature don't miss to get in sync with the changing "default" by doing as follows:
hg pull
hg merge -r default
hg commit -m"merge"
once your feature is ready to be used in the game just like other features, merge it into default:
hg update default
hg merge fooFeature
hg commit -m"merged"

== Publishing changes ==
All the above was read only from the point of view of the main glob2-repository. If you have changes worth sharing you must make them public. Easiest is to pick one of the free mercurial hosters. If you go for [https://bitbucket.org bit bucket] you can fork [[User:Giszmo|Giszmo]]'s [https://bitbucket.org/giszmo/glob2 repository].
With your own bitbucket setup you can check for what would push
hg outgoing https://bitbucket.org/yourBBNick/glob2
and push your changes there:
hg push https://bitbucket.org/yourBBNick/glob2

Now after you checked all is fine you can ask on the glob2 mailing list for someone with write access to the main repo to pull your changes. Asking on the irc is an option, too but for bigger changes you review might take some time and then it is safer to do it via the mailing list.

Don't forget to change the authors file if it's your first contribution ;)

If you are a regular contributor you may get write permissions for the central repo from [[User:Nct|Nct]]. You can mail him your username and password at stephane [at] magnenat [dot] net.

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mercurial

2010-08-21T15:44:22Z

Giszmo:

{{UserManualLinks}}

== Browsing the Project Repository ==
At http://hg.globulation2.org/ you can browse through the repository.

== Tools ==
;hg: To really access a mercurial repository you need mercurial. You can get it from your distribution if you are running Linux or from [http://www.selenic.com/mercurial the mercurial homepage]. An in depth manual of hg you can find [http://hgbook.red-bean.com/read/ here].
;tortoise-hg: To generally access hg repositories at a file system level you might want to use a GUI. [http://tortoisehg.bitbucket.org/ Tortoise-HG] is just great for that.
;HGE: The mercurail plugin for Eclipse is another great way to navigate our repository. You need Eclipse (the CDT-version) and can then get HGE by going to help -> install new software... -> Add... -> Location = http://cbes.javaforge.com/update -> checking mercurial eclipse ...

== Getting a Copy of the Mercurial Repository ==
No matter if you want to contribute with write access or just want to get a read only copy of glob2, you should cd to a directory where you have write permissions and run hg clone:
cd ~/my_hg_repositories
hg clone http://hg.globulation2.org/glob2-new glob2
cd glob2
The same can be achieved using HGE or tortoise-HG.

== Which revision to use ==
Having cloned the repository you now have all the history of glob2 at hands. According to your intents you now might want to choose different revisions to jump to and start working on them. Pick from the subsections what most fits your intents:

=== The player ===
If you want to play against others you need the same '''major''' version of glob2 as they have. If they have betaX.4 you should pick some betaX version. You get the latest version in the betaX release candidate branch using the tip of betaX-rc. To get there issue
hg update betaX-rc

In rare occasions this version might not work. To get a version that was tagged for being released, check the output of
hg tags
for lines matching betaX.y and update to the highest y:
hg update betaX.y

=== The tester ===
If you want to test the latest not yet released version of glob2 you should update to the tip of the latest release candidate (-rc) branch:
hg update betaY-rc
or if a feature freeze was not yet decided on, you can also test the latest version of the default branch:
hg update default

=== The bug fixer ===
You might have started as a tester but now want to actually touch code. Now it is getting slightly more complicated. Having found a bug and a solution to it means applying the fix to the right revision. As bugs often are not only bugs of not yet released features but also express in years old versions you should fix the oldest relevant version. If on the download page beta4 is still promoted, you should fix this and merge your changes up to beta5 and finally to default. In hg this is pretty easy to do:
hg update beta4-rc
do your changes to the code ....
hg commit -m"fixed bug xy ..."
hg update beta5-rc
hg merge beta4-rc
hg commit -m"merge"
hg update default
hg merge beta5-rc
hg commit -m"merge"
Depending on how important the bug-fix was you might now want to directly tag the new versions:
hg tag beta4-rc beta4.X
hg tag beta5-rc beta5.Y

=== The mini-features guy ===
If you have a new small feature to contribute, you do this in "default":
hg update default
do your changes to the code ...
hg commit -m"implemented mini-feature xy"

=== The big-features guy ===
If you have a new big feature to contribute, you do this in a separate branch starting at "default":
hg update default
hg branch fooFeature
work on your feature with a series of
change code
hg commit -m"changed this and that"
but while you work on your feature don't miss to get in sync with the changing "default" by doing as follows:
hg pull
hg merge -r default
hg commit -m"merge"
once your feature is ready to be used in the game just like other features, merge it into default:
hg update default
hg merge fooFeature
hg commit -m"merged"

== Publishing changes ==
All the above was read only from the point of view of the main glob2-repository. If you have changes worth sharing you must make them public. Easiest is to pick one of the free mercurial hosters. If you go for [https://bitbucket.org bit bucket] you can fork [[User:Giszmo|Giszmo]]'s [https://bitbucket.org/giszmo/glob2 repository].
With your own bitbucket setup you can check for what would push
hg outgoing https://bitbucket.org/yourBBNick/glob2
and push your changes there:
hg push https://bitbucket.org/yourBBNick/glob2

Now after you checked all is fine you can ask on the glob2 mailing list for someone with write access to the main repo to pull your changes. Asking on the irc is an option, too but for bigger changes you review might take some time and then it is safer to do it via the mailing list.

Don't forget to change the authors file if it's your first contribution ;)

If you are a regular contributor you may get write permissions for the central repo from [[User:Nct|Nct]]. You can mail him your username and password at stephane [at] magnenat [dot] net.

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mercurial

2010-08-21T15:43:24Z

Giszmo:

{{UserManualLinks}}

== Browsing the Project Repository ==
At http://hg.globulation2.org/ you can browse through the repository.

== Tools ==
;hg: To really access a mercurial repository you need mercurial. You can get it from your distribution if you are running Linux or from [http://www.selenic.com/mercurial the mercurial homepage]. An in depth manual of hg you can find [http://hgbook.red-bean.com/read/ here].
;tortoise-hg: To generally access hg repositories at a file system level you might want to use a GUI. [http://tortoisehg.bitbucket.org/ Tortoise-HG] is just great for that.
;HGE: The mercurail plugin for Eclipse is another great way to navigate our repository. You need Eclipse (the CDT-version) and can then get HGE by going to help -> install new software... -> Add... -> Location = http://cbes.javaforge.com/update -> checking mercurial eclipse ...

== Getting a Copy of the Mercurial Repository ==
No matter if you want to contribute with write access or just want to get a read only copy of glob2, you should cd to a directory where you have write permissions and run hg clone:
cd ~/my_hg_repositories
hg clone http://hg.globulation2.org/glob2-new glob2
cd glob2
The same can be achieved using HGE or tortoise-HG.

== Which revision to use ==
Having cloned the repository you now have all the history of glob2 at hands. According to your intents you now might want to choose different revisions to jump to and start working on them. Pick from the subsections what most fits your intents:

=== The player ===
If you want to play against others you need the same '''major''' version of glob2 as they have. If they have betaX.4 you should pick some betaX version. You get the latest version in the betaX release candidate branch using the tip of betaX-rc. To get there issue
hg update betaX-rc

In rare occasions this version might not work. To get a version that was tagged for being released, check the output of
hg tags
for lines matching betaX.y and update to the highest y:
hg update betaX.y

=== The tester ===
If you want to test the latest not yet released version of glob2 you should update to the tip of the latest release candidate (-rc) branch:
hg update betaY-rc
or if a feature freeze was not yet decided on, you can also test the latest version of the default branch:
hg update default

=== The bug fixer ===
You might have started as a tester but now want to actually touch code. Now it is getting slightly more complicated. Having found a bug and a solution to it means applying the fix to the right revision. As bugs often are not only bugs of not yet released features but also express in years old versions you should fix the oldest relevant version. If on the download page beta4 is still promoted, you should fix this and merge your changes up to beta5 and finally to default. In hg this is pretty easy to do:
hg update beta4-rc
do your changes to the code ....
hg commit -m"fixed bug xy ..."
hg update beta5-rc
hg merge beta4-rc
hg commit -m"merge"
hg update default
hg merge beta5-rc
hg commit -m"merge"
Depending on how important the bug-fix was you might now want to directly tag the new versions:
hg tag beta4-rc beta4.X
hg tag beta5-rc beta5.Y

=== The mini-features guy ===
If you have a new small feature to contribute, you do this in "default":
hg update default
do your changes to the code ...
hg commit -m"implemented mini-feature xy"

=== The big-features guy ===
If you have a new big feature to contribute, you do this in a separate branch starting at "default":
hg update default
hg branch fooFeature
work on your feature with a series of
change code
hg commit -m"changed this and that"
but while you work on your feature don't miss to get in sync with the changing "default" by doing as follows:
hg pull
hg merge -r default
hg commit -m"merge"
once your feature is ready to be used in the game just like other features, merge it into default:
hg update default
hg merge fooFeature
hg commit -m"merged"

== Publishing changes ==
All the above was read only from the point of view of the main glob2-repository. If you have changes worth sharing you must make them public. Easiest is to pick one of the free mercurial hosters. If you go for [https://bitbucket.org bit bucket] you can fork [[User:Giszmo]]'s [https://bitbucket.org/giszmo/glob2 repository].
With your own bitbucket setup you can check for what would push
hg outgoing https://bitbucket.org/yourBBNick/glob2
and push your changes there:
hg push https://bitbucket.org/yourBBNick/glob2

Now after you checked all is fine you can ask on the glob2 mailing list for someone with write access to the main repo to pull your changes. Asking on the irc is an option, too but for bigger changes you review might take some time and then it is safer to do it via the mailing list.

Don't forget to change the authors file if it's your first contribution ;)

If you are a regular contributor you may get write permissions for the central repo from [[User:Nct]]. You can mail him your username and password at stephane [at] magnenat [dot] net.

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mercurial

2010-08-21T15:28:16Z

Giszmo:

{{UserManualLinks}}

== Browsing the Project Repository ==
At http://hg.globulation2.org/ you can browse through the repository.

== Tools ==
;hg: To really access a mercurial repository you need mercurial. You can get it from your distribution if you are running Linux or from [http://www.selenic.com/mercurial the mercurial homepage]. An in depth manual of hg you can find [http://hgbook.red-bean.com/read/ here].
;tortoise-hg: To generally access hg repositories at a file system level you might want to use a GUI. [http://tortoisehg.bitbucket.org/ Tortoise-HG] is just great for that.
;HGE: The mercurail plugin for Eclipse is another great way to navigate our repository. You need Eclipse (the CDT-version) and can then get HGE by going to help -> install new software... -> Add... -> Location = http://cbes.javaforge.com/update -> checking mercurial eclipse ...

== Getting a Copy of the Mercurial Repository ==
No matter if you want to contribute with write access or just want to get a read only copy of glob2, you should cd to a directory where you have write permissions and run hg clone:
cd ~/my_hg_repositories
hg clone http://hg.globulation2.org/glob2-new glob2
cd glob2
The same can be achieved using HGE or tortoise-HG.

== Which revision to use ==
Having cloned the repository you now have all the history of glob2 at hands. According to your intents you now might want to choose different revisions to jump to and start working on them. Pick from the subsections what most fits your intents:

=== The player ===
If you want to play against others you need the same '''major''' version of glob2 as they have. If they have betaX.4 you should pick some betaX version. You get the latest version in the betaX release candidate branch using the tip of betaX-rc. To get there issue
hg update betaX-rc

In rare occasions this version might not work. To get a version that was tagged for being released, check the output of
hg tags
for lines matching betaX.y and update to the highest y:
hg update betaX.y

=== The tester ===
If you want to test the latest not yet released version of glob2 you should update to the tip of the latest release candidate (-rc) branch:
hg update betaY-rc
or if a feature freeze was not yet decided on, you can also test the latest version of the default branch:
hg update default

=== The bug fixer ===
You might have started as a tester but now want to actually touch code. Now it is getting slightly more complicated. Having found a bug and a solution to it means applying the fix to the right revision. As bugs often are not only bugs of not yet released features but also express in years old versions you should fix the oldest relevant version. If on the download page beta4 is still promoted, you should fix this and merge your changes up to beta5 and finally to default. In hg this is pretty easy to do:
hg update beta4-rc
do your changes to the code ....
hg commit -m"fixed bug xy ..."
hg update beta5-rc
hg merge beta4-rc
hg commit -m"merge"
hg update default
hg merge beta5-rc
hg commit -m"merge"
Depending on how important the bug-fix was you might now want to directly tag the new versions:
hg tag beta4-rc beta4.X
hg tag beta5-rc beta5.Y

== The mini-features guy ==
If you have a new small feature to contribute, you do this in "default":
hg update default
do your changes to the code ...
hg commit -m"implemented mini-feature xy"

== The big-features guy ==
If you have a new big feature to contribute, you do this in a separate branch starting at "default":
hg update default
hg branch fooFeature
work on your feature with a series of
change code
hg commit -m"changed this and that"
but while you work on your feature don't miss to get in sync with the changing "default" by doing as follows:
hg pull
hg merge -r default
hg commit -m"merge"
once your feature is ready to be used in the game just like other features, merge it into default:
hg update default
hg merge fooFeature
hg commit -m"merged"

== Publishing chanes ==
All the above was read only from the point of view of the main glob2-repository. If you have changes worth sharing you must make them public. Easiest is to pick one of the free mercurial hosters.
Member access is performed using the Mercurial over HTTPS method. Access can be given by providing [[User:Nct]] with a username and password by emailing him at stephane [at] magnenat [dot] net.

When you have commited changes locally (hg commit --message="what you have changed"), you can push the changes to the server using:
hg push -r branch https://hg.globulation2.org/glob2-new/

(change "-r branch" to the branch you wish to commit to, for example "-r default")

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mercurial

2010-08-21T13:16:15Z

Giszmo:

Mercurial

2010-08-21T12:56:50Z

Giszmo: /* A quick overview of Mercurial */

{{UserManualLinks}}

==Browsing Globulation Project Repository using Mercurial system==
NOW a cross-platform software are available to get a powerful GUI -Graphical User Interface- it's call HgTurtoise [http://tortoisehg.bitbucket.org/ More information there].

You can Set HgTurtoise with the parameters below.HgTurtoise seems more complicated than
broswing the web, but the Branch Graphic representation is exelent, and really a Must have on MS_Windows_O.S.

You can visualize with the ''Mercurial software'' the Globulation project repository, even you can do it by browsing the web.This will gives you a picture of the current status of the source files. You may also view the complete histories of any file in the repository as well as differences among two versions:
* http://hg.globulation2.org/

==Getting a Copy of the Mercurial Repository==
NOTE: FEEL FREE TO VISIT THE MERCURY '''[http://www.selenic.com/mercurial/hg.1.html MAN PAGE ONLINE]''' since it not available with all shell.

===Anonymous Mercurial Access===
See [[Download_and_Install#Sources_from_Mercurial|the Mercurial sources download instructions]]

===Pushing changes via HTTPS===
Member access is performed using the Mercurial over HTTPS method. Access can be given by providing [[User:Nct]] with a username and password by emailing him at stephane [at] magnenat [dot] net.

When you have commited changes locally (hg commit --message="what you have changed"), you can push the changes to the server using:
hg push -r branch https://hg.globulation2.org/glob2-new/

(change "-r branch" to the branch you wish to commit to, for example "-r default")

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our "trunk" or default branch is called "'''default'''".
You can try everything with mercurial locally before pushing to the remote repository.
hg log
hg diff
hg branches
hg heads
hg tags
hg incoming
hg outgoing
hg status
are very helpful to get information. Try "hg help" for details.

hg serve //and browsing to localhost:8000
is very good for a graphical overview of the repository structure. If you prefer using a GUI tool, go for [http://tortoisehg.bitbucket.org/ Tortoise-HG].
And you definitely have to set up a merge tool for those case when you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mercurial

2010-08-21T12:38:29Z

Giszmo: /* Browsing Globulation Project Repository using Mercurial system */

{{UserManualLinks}}

==Browsing Globulation Project Repository using Mercurial system==
NOW a cross-platform software are available to get a powerful GUI -Graphical User Interface- it's call HgTurtoise [http://tortoisehg.bitbucket.org/ More information there].

You can Set HgTurtoise with the parameters below.HgTurtoise seems more complicated than
broswing the web, but the Branch Graphic representation is exelent, and really a Must have on MS_Windows_O.S.

You can visualize with the ''Mercurial software'' the Globulation project repository, even you can do it by browsing the web.This will gives you a picture of the current status of the source files. You may also view the complete histories of any file in the repository as well as differences among two versions:
* http://hg.globulation2.org/

==Getting a Copy of the Mercurial Repository==
NOTE: FEEL FREE TO VISIT THE MERCURY '''[http://www.selenic.com/mercurial/hg.1.html MAN PAGE ONLINE]''' since it not available with all shell.

===Anonymous Mercurial Access===
See [[Download_and_Install#Sources_from_Mercurial|the Mercurial sources download instructions]]

===Pushing changes via HTTPS===
Member access is performed using the Mercurial over HTTPS method. Access can be given by providing [[User:Nct]] with a username and password by emailing him at stephane [at] magnenat [dot] net.

When you have commited changes locally (hg commit --message="what you have changed"), you can push the changes to the server using:
hg push -r branch https://hg.globulation2.org/glob2-new/

(change "-r branch" to the branch you wish to commit to, for example "-r default")

==Mercurial Newbies==
If you've never used Mercurial, you should read some documentation about it; a useful URL is http://www.selenic.com/mercurial/wiki/index.cgi/QuickStart. Using Mercurial is not complex but you have to understand what is going on. The best way to start is to ask a friend to show you the way, or pop onto the [irc://irc.globulation2.org/glob2 glob2 development] IRC channel and ask there.
===A quick overview of Mercurial===
Basically you have to know that there is not total order on a mercurial repository. Each revision except the initial revision has at least one parent. Different revisions can have the same parent(s). A revision will have more than one parent, if and only if it is a merge of those parents.

If two or more revisions share a parent, we have infact different branches in the repository. The new mercurial feature allows to give a revision a sticky tag that is past to almost all its children. Exeptions are merges. If you merge branch A into branch B, this revision will belong to branch B. So when you merge the default branch into a development branch, the result will belong to the development branch. This is good because you can keep track of approved changes, during your development now and then. 

*A tag name is associated with a revision ID number.
*A branch name should represent the '''tipmost''' revision of that branch.
*The special tag "'''tip'''" is '''always identifies the most recent revision'''.

Branches might have names, unless you give them a name.Their names don't have to be unique but it is strengthy recommended to don't use an already given name branch to another. So multiple branches were supported all the time. The new feature just allows to name them. You can put the branchname everywhere you can put a revision number. So all commands that have ''''-r'''' or ''''-rev'''' option accept a branchname too. Mercurial will then search the latest revision in that branch and path its number to the command. (At least that's what I think it does.)

{{message|HINT for Tags name & branch|Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.
Tag and branch names must not contain the ":" character.Note that because '''revision numbers''' may be different in different repository clones, the branch tip may be different in different cloned repositories.

For Further details please visit the '''[http://www.selenic.com/mercurial/hg.1.html#tag HG MAN PAGE]'''.}}

If every branch (named or not) has the same "latest revision", our repository will have exactly 1 head. Otherwise we will have more heads and mercurial will suppose that we merge the heads. But most of the time this would be inappropriate, and we shouldn't do it.

The latest revision is always called tip, and mercurial defaults to think that we want to work on it. This is also very sad, if it does belong to an other branch. I really recomment that you only pull the branch you want to use. You can do this, because the clone and pull commands have a ''''-r'''' option. I pull the whole repository on my computer and than pull the branches that I want to work on, from that local repository to different working repositories. I suggest everyone should do this. So there is one incoming repository, one or more working repository and one outgoing repository locally on my computer.

Our default branch I called "'''default'''".
Glob2 players should always pull the default branch.
You can try everything mercurial locally before pushing to the remote repository.
hg help
hg help <command>
hg log
hg diff
hg branch
hg heads
hg incoming
hg outgoing
hg status
are very helpfull.

Please look into the extentions.

hg view
is very good for a graphical overview of the repository structure, though it seems not to display the branch names.I remember to all that a new software are available we help us to get an overview, using an GUI, it's a cross-platform called [http://tortoisehg.bitbucket.org/ HgTurtoise], and it s friendlier than the command line use.
And you definitely have to set up a merge tool for those case when
you have to merge manually.

Branching of should look like this:

*Branch from a revision other than the tip of your local repository:
hg revert --all -r <revision from which you want to branch of>
hg branch <branchname>
hg commit -m "message"
*Cloning from a branch:
''Using -r/--rev (or 'clone src#rev dest') implies --pull, even for local source''. repositories.
hg clone -r <branchname> <location of the repository> <name that you want your repository to have>
*Pulling from a branch:
'Ppulling is implicitly engage when -r option is set within the clone command.''
hg pull -r <branchname> <location of the repository>

[[Category:en]]
[[Category:User Manual]]

Mingw compilation

2010-07-26T20:38:29Z

Giszmo:

This page explains how to compile Globulation 2 on windows using [http://www.mingw.org/ mingw].

== Installing required software for tutorial ==
=== Setting up Python, Scons, Mercurial, and NSIS ===
:* Download and install [http://www.python.org/download/ Python] into the directory "C:\Python26" (default install is Python26, don't change this)
:* Download and install [http://www.scons.org/download.php Scons] into the same directory as the python install (C:\Python26\)
:* Download and install [http://mercurial.berkwood.com/ stable Mercurial] locally so the command hg will work. When you get to the end of the install, make sure you check "add mercurial to your computers search path" or something similar.

(To create a windows installer)
:*Download and install [http://nsis.sourceforge.net/Download NSIS] into all its default installation folder "C:\Program Files\NSIS\".

=== Setting up MinGW and MSYS ===
:*Download and install [http://downloads.sourceforge.net/mingw/MinGW-5.1.4.exe MinGW-5.1.4.exe] into the directory c:\mingw (lower case). During installation, select "Current" when asked what version, and then and select the MinGW base tools and g++ compiler packages only
:*And, download and install [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe 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. When it ask you to indicate the directory where it is installed, type in c:/mingw (yes, with a forward slash as the program prefers it that way).
:*Open msys by double clicking the desktop icon, run the following, then be sure to close the window so it takes effect:
echo "c:/mingw /mingw" > /etc/fstab
=== Compiling Prerequisites ===
:*Download [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2 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)
:*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 /

==Compiling Globulation 2==
===Step 1: Preparing for a compile===
====Compiling from Released source code====
:*Download and extract the release to c:\msys\1.0\home\XXX\ (where XXX is the username), then run (changing the version numbers):
mv glob2-x.x.xx glob2_source
====Compiling from Mercurial source files====
* Download Globulation 2 from mercurial
hg clone http://hg.globulation2.org/glob2-new glob2
: The above command gets you all the history of glob2 back to November 2001 when it all began.
* Pick a version you want to compile
cd glob2
hg branches
hg tags
: these commands give you an overview of what branches and tags exist.
: Tags are used to mark certain versions like when glob2 publishes a new released. beta4.5 for example is the 5th version of the beta-4 series of releases. 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. '''tip''' is a special tag. It is the revision last committed to the repository. In general this is not what you want but you get it by default.
: Branches are used to mark a sequence of revisions that are not necessarily all stable. Somewhere after beta4.5 on the beta4-rc branch there may be versions that don't compile. If you want to help on a beta4.6 you would need to get the branch beta4-rc. '''default''' is the main branch. If you want to play this is not the branch you want. If you want to fix bugs, this is not what you want as bugs get fixed in the earliest supported branches (those with an -rc). 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).
* update to the right revision.
hg update -C \[branch name or tag name you picked above\]

===Step 2: actually compiling===
:*Start compiling Globulation 2. Don't worry about the warnings. If something is wrong, it will grind to a halt and it will let you know why. To compile, run (inside the folder glob2):
scons
:*Once compiling has finished, run 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 directory and play :)

===Building a Globulation 2 NSIS installer===
:*In MSYS, run the following codes to compile a windows installable exe file:
cd glob2_source
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==
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.)

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.

==Conclusion==
That concludes this Mingw compilation tutorial. If you have any problems, 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. Happy compiling.

[[Category:en]]
[[Category:Developer Resources]]

Mingw compilation

2010-07-26T20:36:44Z

Giszmo: /* Compiling from Mercurial source files */

This page explains how to compile Globulation 2 on windows using [http://www.mingw.org/ mingw].

== Installing required software for tutorial ==
=== Setting up Python, Scons, Mercurial, and NSIS ===
:* Download and install [http://www.python.org/download/ Python] into the directory "C:\Python26" (default install is Python26, don't change this)
:* Download and install [http://www.scons.org/download.php Scons] into the same directory as the python install (C:\Python26\)
:* Download and install [http://mercurial.berkwood.com/ stable Mercurial] locally so the command hg will work. When you get to the end of the install, make sure you check "add mercurial to your computers search path" or something similar.

(To create a windows installer)
:*Download and install [http://nsis.sourceforge.net/Download NSIS] into all its default installation folder "C:\Program Files\NSIS\".

=== Setting up MinGW and MSYS ===
:*Download and install [http://downloads.sourceforge.net/mingw/MinGW-5.1.4.exe MinGW-5.1.4.exe] into the directory c:\mingw (lower case). During installation, select "Current" when asked what version, and then and select the MinGW base tools and g++ compiler packages only
:*And, download and install [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe 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. When it ask you to indicate the directory where it is installed, type in c:/mingw (yes, with a forward slash as the program prefers it that way).
:*Open msys by double clicking the desktop icon, run the following, then be sure to close the window so it takes effect:
echo "c:/mingw /mingw" > /etc/fstab
=== Compiling Prerequisites ===
:*Download [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2 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)
:*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 /

==Compiling Globulation 2==
===Step 1: Preparing for a compile===
====Compiling from Released source code====
:*Download and extract the release to c:\msys\1.0\home\XXX\ (where XXX is the username), then run (changing the version numbers):
mv glob2-x.x.xx glob2_source
====Compiling from Mercurial source files====
* Download Globulation 2 from mercurial
hg clone http://hg.globulation2.org/glob2-new glob2
: The above command gets you all the history of glob2 back to November 2001 when it all began.
* Pick a version you want to compile
cd glob2
hg branches
hg tags
: these commands give you an overview of what branches and tags exist.
: Tags are used to mark certain versions like when glob2 publishes a new released. beta4.5 for example is the 5th version of the beta-4 series of releases. 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. '''tip''' is a special tag. It is the revision last committed to the repository. In general this is not what you want but you get it by default.
: Branches are used to mark a sequence of revisions that are not necessarily all stable. Somewhere after beta4.5 on the beta4-rc branch there may be versions that don't compile. If you want to help on a beta4.6 you would need to get the branch beta4-rc. '''default''' is the main branch. If you want to play this is not the branch you want. If you want to fix bugs, this is not what you want as bugs get fixed in the earliest supported branches (those with an -rc). 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).
* update to the right revision.
hg update -C \[branch name or tag name you picked above\]

===Step 2: Continue compiling===
:*Start compiling Globulation 2. Don't worry about the warnings. If something is wrong, it will grind to a halt and it will let you know why. To compile, run (inside glob2_source):
scons
:*Once compiling has finished, run 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 directory and play :)

===Building a Globulation 2 NSIS installer===
:*In MSYS, run the following codes to compile a windows installable exe file:
cd glob2_source
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==
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.)

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.

==Conclusion==
That concludes this Mingw compilation tutorial. If you have any problems, 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. Happy compiling.

[[Category:en]]
[[Category:Developer Resources]]

Mingw compilation

2010-07-26T20:13:59Z

Giszmo:

This page explains how to compile Globulation 2 on windows using [http://www.mingw.org/ mingw].

== Installing required software for tutorial ==
=== Setting up Python, Scons, Mercurial, and NSIS ===
:* Download and install [http://www.python.org/download/ Python] into the directory "C:\Python26" (default install is Python26, don't change this)
:* Download and install [http://www.scons.org/download.php Scons] into the same directory as the python install (C:\Python26\)
:* Download and install [http://mercurial.berkwood.com/ stable Mercurial] locally so the command hg will work. When you get to the end of the install, make sure you check "add mercurial to your computers search path" or something similar.

(To create a windows installer)
:*Download and install [http://nsis.sourceforge.net/Download NSIS] into all its default installation folder "C:\Program Files\NSIS\".

=== Setting up MinGW and MSYS ===
:*Download and install [http://downloads.sourceforge.net/mingw/MinGW-5.1.4.exe MinGW-5.1.4.exe] into the directory c:\mingw (lower case). During installation, select "Current" when asked what version, and then and select the MinGW base tools and g++ compiler packages only
:*And, download and install [http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe 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. When it ask you to indicate the directory where it is installed, type in c:/mingw (yes, with a forward slash as the program prefers it that way).
:*Open msys by double clicking the desktop icon, run the following, then be sure to close the window so it takes effect:
echo "c:/mingw /mingw" > /etc/fstab
=== Compiling Prerequisites ===
:*Download [http://dl.sv.nongnu.org/releases/glob2/mingw/glob2_required_libs_mingw-scons.tar.bz2 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)
:*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 /

==Compiling Globulation 2==
===Step 1: Preparing for a compile===
====Compiling from Released source code====
:*Download and extract the release to c:\msys\1.0\home\XXX\ (where XXX is the username), then run (changing the version numbers):
mv glob2-x.x.xx glob2_source
====Compiling from Mercurial source files====
:*Download Globulation 2 from mercurial:
hg clone http://hg.globulation2.org/glob2-new
:*Extract the master (the stable branch) from the mercurial download (this can also be used to extract other branches, such as beta4-rc):
hg clone -r default glob2-new glob2_source
:*To compile the latest code, run:
cd glob2_source
hg update -C tip

===Step 2: Continue compiling===
:*Start compiling Globulation 2. Don't worry about the warnings. If something is wrong, it will grind to a halt and it will let you know why. To compile, run (inside glob2_source):
scons
:*Once compiling has finished, run 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 directory and play :)

===Building a Globulation 2 NSIS installer===
:*In MSYS, run the following codes to compile a windows installable exe file:
cd glob2_source
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==
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.)

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.

==Conclusion==
That concludes this Mingw compilation tutorial. If you have any problems, 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. Happy compiling.

[[Category:en]]
[[Category:Developer Resources]]

Beta5 TODO

2010-07-22T12:20:55Z

Giszmo:

Things left to do prior to releasing beta5:
* Beta5 is in feature freeze so any new features will earliest go into beta6
* Beta5 is still open for translations and slight modifications in the map files
* The new feature "replays" produces wrong replays for network games that go unnoticed by the player. Also version changes don't invalidate old replays so they might or might not replay correctly. As replays is the most noticeable new feature I don't see a point in releasing beta5 without replays. A prominent Warning when starting a replay about those bugs might be an option in my opinion as we need to show progress.
* there was something more. please spend an hour on reading the most recent mailing list posts prior to releasing beta5!

Beta5 TODO

2010-07-22T12:17:27Z

Giszmo: New page: Things left to do prior to releasing beta5: * Beta5 is in feature freeze so any new features will earliest go into beta6 * Beta5 is still open for translations and slight modifications in ...

Solution to the guard area distribution problem

2010-06-06T22:54:50Z

Giszmo: /* Difficulties */

== The problem ==
Guard areas have the problem that they share one common gradient per team. This results in all the warriors going to the closest area ignoring the distant ones.

== A possible solution ==
In order to get a more even distribution but at the same time keep the extra [[Gradients|gradient]] count low, the guard area gradient should be split up into several guard '''region''' gradients. One for each connected patch of guard areas. Each such region would need to get some attributes such as:
* count of warriors assigned
* size
* saturation = count of warriors assigned / size
warriors could take the saturation into account when picking a gradient.

== Difficulties ==
Of course it will be non-trivial to optimize distances so that east-warriors don't get assigned to west-regions while west-warriors walk to the east-regions and at the same time guarantee distant regions to get saturated.

Another problem would be the number of extra gradients if players paint small spots of blue along their defence line.

== Conclusion ==
Stupidly long paths through simply picking the least saturated region in range would still be better than what we have now in b4. Going for the above approach would be a first step to turn the so called guard areas into actual guard areas.

Solution to the guard area distribution problem

2010-06-06T22:46:19Z

Giszmo: /* Problem */

== The problem ==
Guard areas have the problem that they share one common gradient per team. This results in all the warriors going to the closest area ignoring the distant ones.

== A possible solution ==
In order to get a more even distribution but at the same time keep the extra [[Gradients|gradient]] count low, the guard area gradient should be split up into several guard '''region''' gradients. One for each connected patch of guard areas. Each such region would need to get some attributes such as:
* count of warriors assigned
* size
* saturation = count of warriors assigned / size
warriors could take the saturation into account when picking a gradient.

== Difficulties ==
Of course it will be non-trivial to optimize distances so that east-warriors don't get assigned to west-regions while west-warriors walk to the east-regions and at the same time guarantee distant regions to get saturated.

== Conclusion ==
Stupidly long paths through simply picking the least saturated region in range would still be better than what we have now in b4. Going for the above approach would be a first step to turn the so called guard areas into actual guard areas.

Solution to the guard area distribution problem

2010-06-06T22:45:46Z

Giszmo: /* A possible solution */

== The problem ==
Guard areas have the problem that they share one common gradient per team. This results in all the warriors going to the closest area ignoring the distant ones.

== A possible solution ==
In order to get a more even distribution but at the same time keep the extra [[Gradients|gradient]] count low, the guard area gradient should be split up into several guard '''region''' gradients. One for each connected patch of guard areas. Each such region would need to get some attributes such as:
* count of warriors assigned
* size
* saturation = count of warriors assigned / size
warriors could take the saturation into account when picking a gradient.

== Problem ==
Of course it will be non-trivial to optimize distances so that east-warriors don't get assigned to west-regions while west-warriors walk to the east-regions and at the same time guarantee distant regions to get saturated.

== Conclusion ==
Stupidly long paths through simply picking the least saturated region in range would still be better than what we have now in b4. Going for the above approach would be a first step to turn the so called guard areas into actual guard areas.

Solution to the guard area distribution problem

2010-06-06T22:42:47Z

Giszmo: New page: == The problem == Guard areas have the problem that they share one common gradient per team. This results in all the warriors going to the closest area ignoring the distant ones. == A pos...

== The problem ==
Guard areas have the problem that they share one common gradient per team. This results in all the warriors going to the closest area ignoring the distant ones.

== A possible solution ==
In order to get a more even distribution but at the same time keep the extra [[Gradients|gradient]] count low, the guard area gradient should be split up into several guard '''region''' gradients. One for each connected patch of guard areas. Each such region would need to get some attributes such as:
* count of warriors assigned
* size
so those regions have a saturation (warrior-count / size) that warriors could take into account when picking a gradient. Of course it will be non-trivial to optimize distances so that east-warriors don't get assigned to west-regions while west-warriors walk to the east-regions while at the same time guarantee distant regions to get saturated but stupidly long paths through simply picking the least saturated region in range would still be better than what we have now in b4.

Gradients

2010-06-06T22:31:45Z

Giszmo:

Glob2 directs globs around by means of gradients. For example, to find the nearest wheat field a glob moves to the adjacent square with the highest wheat gradient repeatedly until it hits a wheat square. This is referred to as a "hill-climbing" algorithm.

Each cell on the map has a "gradient" defined for each player, for swimming and non-swimming globs, for each of the following actions:
* Forbidden area
* Guard area
* Every type of resource
* Every building

In other words, there are (width * height * TotalPlayers * 2 * (2 + TotalResources + TotalBuildings) cell gradient values defined.

Gradients are first defined for individual squares in various functions, then those values are propagated around using the Map::propagateGradient() function. Gradients are reduced by one for every square away from a target item (e.g. a wheat square for the wheat gradient).

At least for the Guard Area this approach has a serious [[solution to the guard area distribution problem|problem]] as warriors will always only find the closest guarding area patch and ignore all others.

[[Category:en]]
[[Category:Developer Resources]]

User Manual

2010-04-18T09:36:13Z

Giszmo: /* Logging in */

{{Translations|View this page in|Article=User_Manual}}
{{UserManualLinks}}

To get the game see [[Download_and_Install]]!

<div style="float:left; width:300px; margin: 0 20px 20px 0;">__TOC__</div>
=The main menu=
[[Image:fullscreen_main_menu.png|300px]] 
The main menu is what it is. It is allows you to select several sub menus discussed more in detail below.
==Campaign==
Here are the single player campaigns. Train with these to be fit for YOG.
==Load game==
Here you can load games for single player mode. It doesn't matter if you saved them in YOG, a LAN game, a custom game, a campaign or a tutorial. Auto save games can also be loaded from here.

==Ysagoon Online Gaming (YOG)==
This button connects to the YOG server so you can easily play against others.

===Logging in===
# Choose a nickname.
# Choose a password (Be warned that it will be transmitted without encryption. So please choose a password you don't use for serious stuff.)
# Login

===Inside YOG===
Here you can chat with others, create a game or join games.
;Why are they marked grey and I'm green?:'They' are in the chat room via [irc://irc.globulation2.org/glob2 IRC]. That means they don't have glob2 running but are principally ready to come in if someone asks to.
====Join====
Simply click the game you want to join and then click '''Join'''. Maps will be transfered automatically if needed. If this fails, most likely the game versions don't match.
====Create game====
After clicking on '''Create game''' a menu pops up where you can choose a map or a game (for example the autosavegame of the game that just crashed). By clicking on the maps you get a minimap and infos like dimensions, teams and date of creation.

After pressing Ok the others on YOG will see the game and can join.

By clicking on the colors of the players the host can change them. Same color is '''not''' same team but same people. That means the players with the same color will share the control of one people.

The host can also add AIs to any color.

==Settings==
In this sub menu you can
;select the '''language''' in which the program will display messages and menus:In August 2006 Globulation 2 supported 20 different languages.

;select whether to play in '''full screen mode''' or in '''windowed mode''':In windowed mode you will not be able to navigate by moving the pointer to the border of the screen.

;select the '''resolution''':Globulation 2 supports any modes your graphics card claims. If you experience speed problems, opt for a low resolution.

;switch OpenGL:If you experience speed issues check if you are just emulating OpenGL.

;switch quality:that is to my knowledge only the cloud shadows.

;switch custom cursor:switch off this cute feature if you are on a slow system.

;switch 'remember unit':this feature allows you to assign as many units to a job as you have assigned the last time to a similar one.

;choose your username:the username allows you to be known by others
:the online registration allows a free and password protected way to register your online username

;switch audio:so far this only switches the event sensitive background music on and off.

;set Building Settings:in this tab you can set the default unit count for the flags, buildings, building upgrades and construction sites.

;set Keyboard Shortcuts:here you can modify the default hotkeys for the game and editor.

==Credits==
Here you can read who's giving this game to you.
==Tutorial==
Here you can play these introductory missions to learn the basics of the gameplay.
==Custom game==
Here you can choose a map to play against the various bots.
==LAN Game==
If you have no internet it is also possible to play against each other without YOG via this button. You will have to know your IP. Your IP can be checked [http://whatismyipaddress.com/ here], for instance.
==Editor==
Globulation 2 makes it easy to everybody to set up their own maps.
For detailed info please have a look at our [[Map_editor_guide| map editor guide]].

==Quit==
Well ... Any questions about that?

=Game and strategy=
==The screen==
===The top line===
[[Image:TopLine.png]]

Here you can see in this order beginning from the left:
;-1/5
:free workers/total workers
:this number is red, as there are more workers assigned to jobs than there are in total.
;2/2
:free explorers/total explorers
:all the 2 explorers are free to be assigned to an exploration flag.
;0/0
:free warriors/total warriors
:0 there are zero warriors available to a war flag or guard post
;0/0/500
:your [[Prestige|prestige]]/total prestige on the map/prestige needed to finish the game.
:You get prestige with level 3 schools.
;+0/-0
:this is the number of globs that have converted to and from your team. Globs can be enticed to convert to different teams if the enemy offers a wider variety of [[Fruit_and_conversion|fruits]] at their inns.
;green bar
:this bar indicates if the game is slowed down by the limitations of your system. As long as it is green, everything is fine. Past this white line indicating 100% it turns red. At 200% the game runs about at half the speed it is designed for.
:if this bar is all red, please try to fix that before joining a game on YOG. You can also ask on the game chat for help to get the game go faster. As a rule of thumb the game should be playable on a 1GHz CPU without accelerated OpenGL.
;the menu:this circle in the screenshot is the button to access the menu where you can load/save the game, make alliances, change in-game options and quit the game.

===The right side===
{|
| [[Image:RightSideMenu.png]] ||
Here you have:
;a mini map
:click and drag to quickly navigate to remote areas
:watch to see if enemies are on the way
:team members can show you spots on that map (key '''m''')
;a section with up to four buttons:
:these are for [[Buildings|buildings]], [[Flags_and_special_areas| flags and special areas]], [[Statistics|statistics]] and [[Graphs|graphs]].
:please see details there.
|}

===The center===
Here you see what's going on. You can click the buildings and flags to adjust settings. The units can also be selected to see their status but not to control them directly.

==Buildings==
===Construction cost===
When in the building panel on the right side of the screen, you see thumbnails of buildings. Hover over those thumbnails to see more details about construction costs.
===Destroy, upgrade, and repair buildings===
Click on a building. There is a "destroy" (hotkey '''d''') button at the bottom right of your screen. Click it to delete the building. If you can, there will be an '''Upgrade''' (hotkey '''u''') button just above the '''Destroy''' button. When a building is damaged, you will also see a '''Repair''' (hotkey '''r''') button which asks your creatures to repair the building.
==="Points"===
On each side of an Inn/Swarm, there is a '''column of black dots''' :
*The left one indicates how much wheat is in your Inn/Swarm.
*The right one, also found at training buildings, indicates how many globuls are inside. It tells you how many globuls are eating (for the Inn), how many warriors are training (training camp) etc.
===Description of buildings===
There are many type of buildings documented on [[Buildings| the buildings page]].
===Placement of buildings===
[[Image:Compact1.jpg|200px]]

To avoid terrible traffic jams, leave 2 wide ways for globs to walk past each other

[[Image:Compact.jpg|200px]]

or build more compact. In this picture you have more buildings, all are accesible and you will have less jams except for when you do upgrades.

==Units==

'''''Gathering information on units'''''

*Food, hit points: there should be creatures of the same color as your Swarm in your main window. There are a blue and a green bar under each creature. The '''blue bar shows how much food the creature''' has left, and the green one indicates its hit points or life points. If the blue bar is empty, your creature is starving, and its hitpoints will decrease.

*Other informations: Click on one of your creatures. It is probably a worker. On the right side of your screen you can now see how hungry and healthy it is, what it is carrying, and how good its abilities are.

*Other statistics and information on your units can be seen if you click the fourth of the buttons located directly under your mini-map. There are detailed informations on health and many others.

'''''No orders!'''''

'''You cannot give any kind of orders to your creatures.''' This is done indirectly through your buildings and [[Flags_and_special_areas | flags]]. You can use the '''t key''' to show/hide the path to the current target of the selected unit.

'''''The creatures'''''

Other units besides the '''Workers''' [[Image:Worker.png]] are the '''Warriors''' [[Image:Warrior.png]] and the '''Explorers''' [[Image:exp.png]].

*The '''Warriors''' can attack other land creatures and structures; they can be improved via the training camp, the pool, and the running court. They can be recognized as the units with big arms.

*The '''Explorers''' will keep your map up to date and show you live units that are within their sight. They can attack other flying objects and when they've been through a school of level 3, they can attack ground creatures. They can be recognized as the flying units.

*All creatures eat in inns, they will each take one fruit of each available variety and one unit of wheat. Their satisfaction level will depend on the fruits they had (from 0 to 3) and will determine whether they are attracted to the enemy's inns.

==Alliances==

There are four '''alliance levels''':

*Allied and shared vision

*Show markets so that fruit can be exchanged (note: markets are broken in 0.9.4 release, fruit exchange doesn't work)

*Show Inns so that enemy units can perhaps convert

*Don't show anything

When you ally with someone, there won't be fighting between you.

==Victory==

Except with a few maps that specify particular conditions for victory, there are three basic ways of winning in Globulation 2:

*[[Fruit_and_conversion|Convert]] all of your enemy's globs to your team by using fruits.

*[[Combat|Destroying]] all of your enemy's globs

*Reaching the [[Prestige|prestige]] limit before anyone else

In practice, most games are won through a combination of the first two, while the last (prestige) is only used when stalemate has long been reached.

=Keyboard shortcuts=

Most keyboard shortcuts can be edited in the settings menu but here are the default controls:

*Hit the space bar to jump to the location of the last event that appeared on-screen

*Hold down the letter 'a' to show the team that each unit and building belongs to

*Hit 't' to toggle showing of where each of your units is headed to

*Hit escape to show the in-game menu

*Hit 'p' at any time to pause the game

*Hit 'u' to upgrade a building, or 'r' to repair it

*Hit 'd' to destroy a building or flag. Be very careful, as it doesn't ask you if you're sure before destroying your Swarm

*When a building is selected, you can hit TAB to cycle between all your buildings of the same type

*When a building is selected, you can hit '+/-' to modify its assigned number of workers

*Hit 'h' to show/hide text history

*Use the arrows to move or speed up your view-frame

=Got lost? Example of a simple game=

'''''Buildings you place first in order:'''''

These are all the steps regarding the buildings you will construct:

*you will normally have a '''Swarm''' when you begin a game. If not, you can build it later, since your first priority is to '''build an Inn''' or two. Your creatures will get hungry, the Inn will provide them with food. Don't forget to assign enough workers to the Inn after it is finished (depends on how far away your wheat field is);

*The swarm allows you to build more units, and, depending on how many units you want, you should build one, two, or maybe even three swarms. Look at how much food you have to decide how many units you can maintain. In this game having more units is not always better. Units that are hungry will certainly die very fast.

*'''Build a hospital''': It is easy to build and it is the only way for your units to recover hitpoints;

*'''Barracks''' will improve the strength of Warriors, a '''Racetrack''' is needed if you want your units to move faster on the ground, and a '''Swimming Pool''' will allow your units to move through water. Depending on your priorities, now decide to build one of these three buildings.

*Upgrading your buildings vastly improves their effectiveness. But to do so, '''you need a School'''. To build a School, your creatures need to be able to swim, so that they can collect the Algae. Therefore, we must build a Swimming Pool first. When it is finished, place a School.

*Other useful structures to have are the '''Defense Tower''' and the '''Wall'''. A defense tower surrounded by or on the other side of a wall is especially hard for the enemy to destroy, and low-level warriors won't be able to do much damage to a defense tower anyway (but they can kill workers assigned to it, causing it to run out of ammunition). Walls can also keep resources from growing in annoying places and can isolate resources you have no plans to exploit or wish to keep out of reach of enemy workers.

*Against another human player, there can be a rush to destroy each other's nearby algae completely to prevent the enemy from having advanced buildings too easily. AI are not smart enough to do it to you, but certain players have been known to try it every game! So send a few warriors to protect yours. Defense towers are nice for this purpose as they don't require feeding and won't convert to the enemy; but to fight an algae genocide rush, you need warriors who can swim.

*As soon as the first workers have finished school, you get the option to '''upgrade buildings'''. Swarms, Markets and Stone Walls cannot be upgraded, others buildings can be upgraded twice. To upgrade to higher levels, you must first upgrade your School and train some workers (it's a common error to assign 20 workers to upgrade something ASAP when only a few have the proper build level - be careful). Workers trained in School can not only upgrade buildings, but also gather resources much faster.

*As a general rule of thumb explorers are weak against towers, towers are weak against warriors, and warriors are weak against explorers (once the explorer ground attack is researched).

'''''Organization of creatures'''''

In order to raise a healthy colony you need to:

*'''Take your time''' to build all these buildings. The most important resource for your creatures is food. Once you have enough food and workers '''upgrade buildings one by one'''.

*Assign more workers when upgrading, and it will take less time until the new and improved building is available. Don't wait for a building to be finished slowly. And don't forget that after your building is upgraded, you still need all your units to train inside your building. It will take some time until you will see your units go faster or fight better.

*Also don't forget to manage your units with [[Flags_and_special_areas| flags and special areas]].

=Further readings=
* [[Frequently Asked Questions]], if you have unanswered questions
* [[Units]]
* [[Buildings]]
* [[Maps]]
* [[Prestige]]
* [[Combat]]
* [[Fruit and conversion]]
* [[Flags and special areas]]
* [[AI|Artificial Intelligences]]
* [[YOG|Ysagoon Online Gaming]] (metaserver)
* [[Farming]]

[[Category:en]]
[[Category:User Manual]]

User Manual

2010-04-18T09:35:50Z

Giszmo: /* Load game */

{{Translations|View this page in|Article=User_Manual}}
{{UserManualLinks}}

To get the game see [[Download_and_Install]]!

<div style="float:left; width:300px; margin: 0 20px 20px 0;">__TOC__</div>
=The main menu=
[[Image:fullscreen_main_menu.png|300px]] 
The main menu is what it is. It is allows you to select several sub menus discussed more in detail below.
==Campaign==
Here are the single player campaigns. Train with these to be fit for YOG.
==Load game==
Here you can load games for single player mode. It doesn't matter if you saved them in YOG, a LAN game, a custom game, a campaign or a tutorial. Auto save games can also be loaded from here.

==Ysagoon Online Gaming (YOG)==
This button connects to the YOG server so you can easily play against others.

===Logging in===
#Choose a nickname.
#Choose a password (Be warned that it will be transmitted without encryption. So please choose a password you don't use for serious stuff.)
#Login

===Inside YOG===
Here you can chat with others, create a game or join games.
;Why are they marked grey and I'm green?:'They' are in the chat room via [irc://irc.globulation2.org/glob2 IRC]. That means they don't have glob2 running but are principally ready to come in if someone asks to.
====Join====
Simply click the game you want to join and then click '''Join'''. Maps will be transfered automatically if needed. If this fails, most likely the game versions don't match.
====Create game====
After clicking on '''Create game''' a menu pops up where you can choose a map or a game (for example the autosavegame of the game that just crashed). By clicking on the maps you get a minimap and infos like dimensions, teams and date of creation.

After pressing Ok the others on YOG will see the game and can join.

By clicking on the colors of the players the host can change them. Same color is '''not''' same team but same people. That means the players with the same color will share the control of one people.

The host can also add AIs to any color.

==Settings==
In this sub menu you can
;select the '''language''' in which the program will display messages and menus:In August 2006 Globulation 2 supported 20 different languages.

;select whether to play in '''full screen mode''' or in '''windowed mode''':In windowed mode you will not be able to navigate by moving the pointer to the border of the screen.

;select the '''resolution''':Globulation 2 supports any modes your graphics card claims. If you experience speed problems, opt for a low resolution.

;switch OpenGL:If you experience speed issues check if you are just emulating OpenGL.

;switch quality:that is to my knowledge only the cloud shadows.

;switch custom cursor:switch off this cute feature if you are on a slow system.

;switch 'remember unit':this feature allows you to assign as many units to a job as you have assigned the last time to a similar one.

;choose your username:the username allows you to be known by others
:the online registration allows a free and password protected way to register your online username

;switch audio:so far this only switches the event sensitive background music on and off.

;set Building Settings:in this tab you can set the default unit count for the flags, buildings, building upgrades and construction sites.

;set Keyboard Shortcuts:here you can modify the default hotkeys for the game and editor.

==Credits==
Here you can read who's giving this game to you.
==Tutorial==
Here you can play these introductory missions to learn the basics of the gameplay.
==Custom game==
Here you can choose a map to play against the various bots.
==LAN Game==
If you have no internet it is also possible to play against each other without YOG via this button. You will have to know your IP. Your IP can be checked [http://whatismyipaddress.com/ here], for instance.
==Editor==
Globulation 2 makes it easy to everybody to set up their own maps.
For detailed info please have a look at our [[Map_editor_guide| map editor guide]].

==Quit==
Well ... Any questions about that?

=Game and strategy=
==The screen==
===The top line===
[[Image:TopLine.png]]

Here you can see in this order beginning from the left:
;-1/5
:free workers/total workers
:this number is red, as there are more workers assigned to jobs than there are in total.
;2/2
:free explorers/total explorers
:all the 2 explorers are free to be assigned to an exploration flag.
;0/0
:free warriors/total warriors
:0 there are zero warriors available to a war flag or guard post
;0/0/500
:your [[Prestige|prestige]]/total prestige on the map/prestige needed to finish the game.
:You get prestige with level 3 schools.
;+0/-0
:this is the number of globs that have converted to and from your team. Globs can be enticed to convert to different teams if the enemy offers a wider variety of [[Fruit_and_conversion|fruits]] at their inns.
;green bar
:this bar indicates if the game is slowed down by the limitations of your system. As long as it is green, everything is fine. Past this white line indicating 100% it turns red. At 200% the game runs about at half the speed it is designed for.
:if this bar is all red, please try to fix that before joining a game on YOG. You can also ask on the game chat for help to get the game go faster. As a rule of thumb the game should be playable on a 1GHz CPU without accelerated OpenGL.
;the menu:this circle in the screenshot is the button to access the menu where you can load/save the game, make alliances, change in-game options and quit the game.

===The right side===
{|
| [[Image:RightSideMenu.png]] ||
Here you have:
;a mini map
:click and drag to quickly navigate to remote areas
:watch to see if enemies are on the way
:team members can show you spots on that map (key '''m''')
;a section with up to four buttons:
:these are for [[Buildings|buildings]], [[Flags_and_special_areas| flags and special areas]], [[Statistics|statistics]] and [[Graphs|graphs]].
:please see details there.
|}

===The center===
Here you see what's going on. You can click the buildings and flags to adjust settings. The units can also be selected to see their status but not to control them directly.

==Buildings==
===Construction cost===
When in the building panel on the right side of the screen, you see thumbnails of buildings. Hover over those thumbnails to see more details about construction costs.
===Destroy, upgrade, and repair buildings===
Click on a building. There is a "destroy" (hotkey '''d''') button at the bottom right of your screen. Click it to delete the building. If you can, there will be an '''Upgrade''' (hotkey '''u''') button just above the '''Destroy''' button. When a building is damaged, you will also see a '''Repair''' (hotkey '''r''') button which asks your creatures to repair the building.
==="Points"===
On each side of an Inn/Swarm, there is a '''column of black dots''' :
*The left one indicates how much wheat is in your Inn/Swarm.
*The right one, also found at training buildings, indicates how many globuls are inside. It tells you how many globuls are eating (for the Inn), how many warriors are training (training camp) etc.
===Description of buildings===
There are many type of buildings documented on [[Buildings| the buildings page]].
===Placement of buildings===
[[Image:Compact1.jpg|200px]]

To avoid terrible traffic jams, leave 2 wide ways for globs to walk past each other

[[Image:Compact.jpg|200px]]

or build more compact. In this picture you have more buildings, all are accesible and you will have less jams except for when you do upgrades.

==Units==

'''''Gathering information on units'''''

*Food, hit points: there should be creatures of the same color as your Swarm in your main window. There are a blue and a green bar under each creature. The '''blue bar shows how much food the creature''' has left, and the green one indicates its hit points or life points. If the blue bar is empty, your creature is starving, and its hitpoints will decrease.

*Other informations: Click on one of your creatures. It is probably a worker. On the right side of your screen you can now see how hungry and healthy it is, what it is carrying, and how good its abilities are.

*Other statistics and information on your units can be seen if you click the fourth of the buttons located directly under your mini-map. There are detailed informations on health and many others.

'''''No orders!'''''

'''You cannot give any kind of orders to your creatures.''' This is done indirectly through your buildings and [[Flags_and_special_areas | flags]]. You can use the '''t key''' to show/hide the path to the current target of the selected unit.

'''''The creatures'''''

Other units besides the '''Workers''' [[Image:Worker.png]] are the '''Warriors''' [[Image:Warrior.png]] and the '''Explorers''' [[Image:exp.png]].

*The '''Warriors''' can attack other land creatures and structures; they can be improved via the training camp, the pool, and the running court. They can be recognized as the units with big arms.

*The '''Explorers''' will keep your map up to date and show you live units that are within their sight. They can attack other flying objects and when they've been through a school of level 3, they can attack ground creatures. They can be recognized as the flying units.

*All creatures eat in inns, they will each take one fruit of each available variety and one unit of wheat. Their satisfaction level will depend on the fruits they had (from 0 to 3) and will determine whether they are attracted to the enemy's inns.

==Alliances==

There are four '''alliance levels''':

*Allied and shared vision

*Show markets so that fruit can be exchanged (note: markets are broken in 0.9.4 release, fruit exchange doesn't work)

*Show Inns so that enemy units can perhaps convert

*Don't show anything

When you ally with someone, there won't be fighting between you.

==Victory==

Except with a few maps that specify particular conditions for victory, there are three basic ways of winning in Globulation 2:

*[[Fruit_and_conversion|Convert]] all of your enemy's globs to your team by using fruits.

*[[Combat|Destroying]] all of your enemy's globs

*Reaching the [[Prestige|prestige]] limit before anyone else

In practice, most games are won through a combination of the first two, while the last (prestige) is only used when stalemate has long been reached.

=Keyboard shortcuts=

Most keyboard shortcuts can be edited in the settings menu but here are the default controls:

*Hit the space bar to jump to the location of the last event that appeared on-screen

*Hold down the letter 'a' to show the team that each unit and building belongs to

*Hit 't' to toggle showing of where each of your units is headed to

*Hit escape to show the in-game menu

*Hit 'p' at any time to pause the game

*Hit 'u' to upgrade a building, or 'r' to repair it

*Hit 'd' to destroy a building or flag. Be very careful, as it doesn't ask you if you're sure before destroying your Swarm

*When a building is selected, you can hit TAB to cycle between all your buildings of the same type

*When a building is selected, you can hit '+/-' to modify its assigned number of workers

*Hit 'h' to show/hide text history

*Use the arrows to move or speed up your view-frame

=Got lost? Example of a simple game=

'''''Buildings you place first in order:'''''

These are all the steps regarding the buildings you will construct:

*you will normally have a '''Swarm''' when you begin a game. If not, you can build it later, since your first priority is to '''build an Inn''' or two. Your creatures will get hungry, the Inn will provide them with food. Don't forget to assign enough workers to the Inn after it is finished (depends on how far away your wheat field is);

*The swarm allows you to build more units, and, depending on how many units you want, you should build one, two, or maybe even three swarms. Look at how much food you have to decide how many units you can maintain. In this game having more units is not always better. Units that are hungry will certainly die very fast.

*'''Build a hospital''': It is easy to build and it is the only way for your units to recover hitpoints;

*'''Barracks''' will improve the strength of Warriors, a '''Racetrack''' is needed if you want your units to move faster on the ground, and a '''Swimming Pool''' will allow your units to move through water. Depending on your priorities, now decide to build one of these three buildings.

*Upgrading your buildings vastly improves their effectiveness. But to do so, '''you need a School'''. To build a School, your creatures need to be able to swim, so that they can collect the Algae. Therefore, we must build a Swimming Pool first. When it is finished, place a School.

*Other useful structures to have are the '''Defense Tower''' and the '''Wall'''. A defense tower surrounded by or on the other side of a wall is especially hard for the enemy to destroy, and low-level warriors won't be able to do much damage to a defense tower anyway (but they can kill workers assigned to it, causing it to run out of ammunition). Walls can also keep resources from growing in annoying places and can isolate resources you have no plans to exploit or wish to keep out of reach of enemy workers.

*Against another human player, there can be a rush to destroy each other's nearby algae completely to prevent the enemy from having advanced buildings too easily. AI are not smart enough to do it to you, but certain players have been known to try it every game! So send a few warriors to protect yours. Defense towers are nice for this purpose as they don't require feeding and won't convert to the enemy; but to fight an algae genocide rush, you need warriors who can swim.

*As soon as the first workers have finished school, you get the option to '''upgrade buildings'''. Swarms, Markets and Stone Walls cannot be upgraded, others buildings can be upgraded twice. To upgrade to higher levels, you must first upgrade your School and train some workers (it's a common error to assign 20 workers to upgrade something ASAP when only a few have the proper build level - be careful). Workers trained in School can not only upgrade buildings, but also gather resources much faster.

*As a general rule of thumb explorers are weak against towers, towers are weak against warriors, and warriors are weak against explorers (once the explorer ground attack is researched).

'''''Organization of creatures'''''

In order to raise a healthy colony you need to:

*'''Take your time''' to build all these buildings. The most important resource for your creatures is food. Once you have enough food and workers '''upgrade buildings one by one'''.

*Assign more workers when upgrading, and it will take less time until the new and improved building is available. Don't wait for a building to be finished slowly. And don't forget that after your building is upgraded, you still need all your units to train inside your building. It will take some time until you will see your units go faster or fight better.

*Also don't forget to manage your units with [[Flags_and_special_areas| flags and special areas]].

=Further readings=
* [[Frequently Asked Questions]], if you have unanswered questions
* [[Units]]
* [[Buildings]]
* [[Maps]]
* [[Prestige]]
* [[Combat]]
* [[Fruit and conversion]]
* [[Flags and special areas]]
* [[AI|Artificial Intelligences]]
* [[YOG|Ysagoon Online Gaming]] (metaserver)
* [[Farming]]

[[Category:en]]
[[Category:User Manual]]

User:Giszmo

2010-02-21T14:25:32Z

Giszmo:

== color transformation for color blind people ==

glob2's team coloring already allows to use more than one color for the team layer. in order to make it easier for color blind people to distinguish units and buildings, we should use more than one color. for aesthetic reasons we also should use more than shades of brightness of one color.

In the following image left colon is what we have now. right is what could be done with no effort at all. The main color red, green and turquoise are visible at first sight for non-color-blinds but color blinds should also be able to distinguish the "green" from the "red" building.

[[Image:Colortrans.png]]

File:Colortrans.png

2010-02-21T14:19:19Z

Giszmo:

MediaWiki:Sidebar

2010-01-26T11:06:16Z

Giszmo: irc added