Spring - User contributions [en]

AI:Skirmish:List

2015-03-14T13:21:27Z

Cranphin: /* Under Active Development */

[[Main_Page|Main Page]] < AIs

Basics about [[AI:Skirmish|Skirmish AIs]] in Spring.

==== Under Active Development ====
Listed in alphabetical order.

; '''[[AI:AAI|AAI]]''' : config-based, C++, uses learning techniques, by [[User:Submarine|Submarine]]

; '''[[AI:BAI|BAI]]''' : config-less, Java, BA only, by Petah

; '''[[AI:BKPAI|BKPAI]]''' : config-less, C++, Kernel Panic only, by Baczek

; '''[[Spring_Tanks]]' Borked Advancer''' : config-less, Lua, Spring Tanks only, by knorke
(Spring Tanks included AI is hardly an "intelligence" but might be usefull if you want to look at an example of a very bare-bones Lua AI. The file is Gadgets\tpAIbork.lua)

; '''[[AI:C.R.A.I.G.|C.R.A.I.G.]]''' : config-based, Lua, currently [http://spring1944.net/ Spring 1944] and [http://www.imperialwinter.com/ SWIW] only, by Tobi

; '''[https://github.com/cranphin/crans-java-ai CransJavaAI]''' : config-less, Java, port of KAIK, by cranphin

; '''[http://code.google.com/p/spring-djai/ DJAI]''' : config-based, Java, by DJ

; '''[http://springrts.com/phpbb/viewtopic.php?f=15&t=19450 E323AI]''' : config-based, C++, plays XTA, BA & BOTA by [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=4131 Error323] & [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=6441 Simon Logic]

; '''[[AI:HughAI|HughAI]]''' : config-based, Java, port of CSAI, by Hugh Perkins

; '''[[AI:KAIK|KAIK]]''' : config-less, C++, best suited for *A mods, based on [[AI:KAI|KAI]] by Krogothe, now developed by [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=3405 Kloot]

; '''[http://springrts.com/phpbb/viewtopic.php?f=55&t=28259 NOE]''' : config-based, Lua, AI for NOTA, gadget AI ready to use, developed by [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=9850 PepeAmpere]. Widget version planned. Small [http://code.google.com/p/nota/wiki/NOE_introduction manual on project Wiki].

; '''[[AI:NTAI|NTai]]''' : config-based, C++, the longest running AI, currently non-functional, by [[User:AF|AF]]

; '''[[AI:RAI|RAI]]''' : config-less, C++, supports many mods due to its universality, by [http://springrts.com/phpbb/memberlist.php?mode=viewprofile&u=2771 Reth]

; '''[[AI:Shard|Shard]]''' : config-based, C++ & Lua, highly configurable/adjustable, by [[User:AF|AF]]

==== Special ====

; '''[[AI:NullAI|NullAI]]''' : C Test AI, does nothing 
; '''[[AI:NullJavaAI|NullJavaAI]]''' : basic Java Test AI, does nothing 
; '''[[AI:NullLegacyCppAI|NullLegacyCppAI]]''' : Legacy C++ Test AI, does nothing 
; '''[[AI:NullOOJavaAI|NullOOJavaAI]]''' : Java Test AI using the OO wrapper, does nothing 

==== No Longer Under Development ====
None of these AIs will work with the current spring release version.
They are listed here, in case someone wants to take up development again,
and for code reference.

; '''[[AI:AGAI|AGAI]]''' : config-less, Java, by [[User:abma|abma]] 
; '''[[AI:CSAI|CSAI]]''' : C# AI, by Hugh Perkins 
; '''[[AI:JAI|JAI]]''' : first try at writing an AI in Java, by [[User:hoijui|hoijui]] 
; '''[[AI:JCAI|JCAI]]''' : by Zaphod 
; '''[[AI:KAI|KAI]]''' : by Krogothe 
; '''[[AI:MyAI|MyAI]]''' : An earlier AI, by Berion 
; '''[[AI:OTAI|OTAI]]''' : V1.13, An AI aimed at emulating the AI in OTA, by Veylon 
; '''[[AI:QAI|QAI]]''' : V2.42, A half finished AI, by Qman 
; '''[[AI:SAI|SAI]]''' : V0.15, by Spectre 
; '''[[AI:TSI|TSI]]''' : A Polish project, originally based on [[AI:SAI|SAI]] 
; '''[[AI:TAI|TAI]]''' : replaced by [[AI:NTAI|NTai]], by [[User:AF|AF]] 
; '''[[AI:ZcAIn|ZcAIn]]''' : by Cain 

==== Planned For Development ====
; '''[[AI:Epic|Epic]]''' : Next Gen AI, planned by [[User:AF|AF]] 
; '''[[AI:GAI|GAI]]''' : Groovy AI, planned by [[User:hoijui|hoijui]] 
; '''[http://github.com/ato/clojai/tree/master ClojAI]''' : Clojure AI, planned by ato
[[Category: AI]]

Crans Building Spring on Windows Log

2011-05-09T21:57:23Z

Cranphin:

NOTE:
Learned much since, so need to redo.
* dos2unix.exe part of minglibs, but not picked up on clean install (it's called from a batch file expecting it in PATH, %MINGWLIBS%, or the third argument to the batch file, which isn't passed atm. Should have a find*.cmake file for that really). BUT, dos2unix is only used if git's core.autocrlf is set to false, so instead use: core.safecrlf = false + core.autocrlf = true.
* TDM with dwarf2 is preferred over 'plain' mingw, and has a properly working collect2.exe. Only there's a little naming thing then 'gcc-dw2'.

Right, the current building on windows with MinGW instructions for master seem outdated/broken/etc. :)

Since the new MinGW versions, things have become easier and more reliable.
So to help others, I'll log here how I can make a working windows build from scratch.

I know this initial page isn't well formatted, I'll leave that to when I feel like it, or someone else does. Right now it seems more important to have some working instructions.

I can't test on anything other then my own system, which is Windows7, 64 bit.
The date of all this is April 30, 2011.

Although this builds, and runs, you may have issues, since it is master. I certainly have some :) But since the buildbot windows builds have the same issues at the moment, I assume this is due to master having some issues, and not the build procedure.

Keep in mind that these steps describe using the latest available versions of everything. Currently this works pretty well, and is by far the easiest. But this may certainly change in the future.

Steps:
* For the Java AI bits, you'll want to have a 32 bit JDK installed, I'm currently using jdk1.6.0_24. Things may build without, but I'm doing a Java AI, so not gonna test without Java :)
* You'll need a working MinGW, this used to be a pain, but with recent updates this has become a lot better.
** Read the page on http://www.mingw.org/wiki/Getting_Started, just to get your bearings.
** Grab the lastest mingw-get-inst from http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst. I'm using mingw-get-inst-20110316.exe.
** Run the installer, choose to download the latest repository catalogues, accept the license
** I'd recommend using the default install location of C:\MinGW, check if you didn't already have something there before installing :)
** Whether you create start menu folders/desktop links/etc. is up to you.
** From the available packages, select at least C++ compiler, adding MinGW Developer Toolkit works quite well, but is a rather big download. Not adding it means we need to add some more packages later.
** Now the installer will do it's work, this will take some time. I usually get some errors/warnings about files which couldn't be downloaded (sourceforge hickups I figure), but as far as I can tell it'll retry them.
** You'll need to add the bin sub folder where you installed MinGW to the PATH environment variable, most reading this will know what to do, otherwise the MinGW getting started page covers it well.
** If all went well, you should now have some working tools. Open a cmd.exe (windows command shell), and type 'g++ --version', this should tell you you've now got a 4.5.2 or higher g++ compiler.
** Spring needs the dos2unix tool to build, which is not installed by default. Use the command 'mingw-get install cygutils-dos2unix' to grab it.
** If you did not install the MinGW Developer Toolkit, you'll have to install mingw32-make, use: 'mingw-get install mingw32-make'
** Because of a 'bug' (See https://sourceforge.net/tracker/?func=detail&aid=3295175&group_id=2435&atid=102435), we'll have to replace the installed collect2.exe. Get the gcc-4.5.2-tdm-1-core.zip from: https://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%204.5%20series/4.5.2-tdm-1%20SJLJ/ (or a newer version in the same location. These are TDM MinGW builds, alternative builds of MinGW, and he's got a fix in for this issue), unpack the zip file to a temporary location, and copy the contained libexec\gcc\mingw32\4.5.2\collect2.exe to C:\MinGW\libexec\gcc\mingw32\4.5.2 or similar, replacing the existing collect2.exe. Hopefully they'll do something with the bug report and fix this :)
* I'm assuming you'll want to use git to get master, so you'll need the git client.
** Get the latest client from: http://code.google.com/p/msysgit/downloads/list Currently the most recent is 'Git-1.7.4-preview20110204.exe', detailing all the settings is a bit out of scope here, I have found that choosing for it to do no newline conversions tends to work the best with Spring :)
** We'll get the source now, start with 'git clone git://github.com/spring/spring.git' This will create a 'spring' folder in the folder you execute the command from. This spring folder will contain the source.
** If at a later time you want to update this source, go to the spring folder, and use 'git pull --rebase'.
* Ok, we're nearly done, we now need the 'mingwlibs', our own collection of libraries and stuff needed to build on windows. Your best bet is to get it from https://github.com/spring/mingwlibs (which always is the most recent, we need the latest for master), it has a big Downloads button. Use that to get a zip, and put the zip's content under out spring folder, in a subfolder 'mingwlibs'.
* Well, nearlyish, we need CMake now, get and install the latest from http://www.cmake.org/cmake/resources/software.html. 2.8.4 works fine for me atm.
* Now run cmake-ui (it should have put a icon on the desktop).
** Select the source folder, it's the spring folder you got with git.
** Choose a build folder, it doesn't have to exist yet, I use a 'build' folder next to the 'spring' folder.
** Hit the configure button. Use defaults in the generator dialog, which should be MinGW Makefiles, and use default native compilers.
** There's now lots of configuration values, luckily defaults work fine normally. The only change I'd recommend is to change CMAKE_INSTALL_PREFIX to something like 'C:/Spring.master' Windows7/VIsta do not like anyone changing stuff under the Program Files folder, so keep spring in the root of C: (or so) tends to prevent a lot of problems. If you've changed anything, hit configure once more.
** Now hit generate, this should create all needed makefiles and stuff.
** If that went well, we're done with CMake, close it.
* Open a new cmd.exe, and go to the new 'build' folder.
* Optionally, type 'set MAKE_COMMAND=mingw32-make -j2', if you have more then one core and want to try multi-processed building (it's faster).
* Cross your fingers and type 'mingw32-make install DESTDIR=C:\' (the DESTDIR part will heed the 'CMAKE_INSTALL_PREFIX' you set earlier).

If things build well, one way to testing things is:
* Get the BA mod from: http://spring-portal.com/index.php/docman/doc_details/314-balanced-annihilation-v71
* Get and install abma's test 'game' from: https://github.com/abma/spring-test-game (you want all contents as zip, the big download button). There's a README included.
* Now start spring.exe, pick a map of your liking, set the 'ai' to Commanders (which only spawns an idle commander for each side), and pick the game/mod name 'Balanced Annihilation modtest-V7.31' notice the 'modtest' bit :)

[[Category:Compiling]]

Building Spring on Windows

2011-05-04T23:15:00Z

Cranphin: /* TDM webinstaller */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

= Essential Tools and Libraries =
If you are new to programming for open-source projects on Windows you'll quickly discover it can often be difficult to find the right software and dependencies. To aid you in your journey you will find stable versions of most of the tools and libraries listed below on [http://www.warriorhut.org/spring this mirror]. Use them if you have trouble finding what you need below.

If you have trouble opening any of the archives please install the application 7zip as it supports all of the archive formats in common use (it's in the tools/archiving subdirectory).

= Compiling on Windows =
For other platforms see [[Building spring]].

==Install MinGW==
Compiling Spring in MinGW requires GCC 4.x 
Because the official MinGW installer & packages are totally outdated and abandoned, we recommend to use the TDM ones instead:

===TDM webinstaller===
Get it here: [http://tdm-gcc.tdragon.net/download TDM-MinGW] (download the webinstaller alias "On-Demand Installer")

Get at least the following packages:
* gcc (version dw2/dwarf2!)
** core
** g++
* binutils
* mingw-runtime
* win32api

* gdb (recommended for debugging)
* openmp (optional)

If you get undefined ... _Unwind_Resume linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2''.

When using ''dwarf2'' as suggested, the compilers will be named abc-dw2. Rename (atleast) these two, or CMake will fail:
* "C:/MinGW32/bin/gcc-dw2.exe" to "gcc.exe"
* "C:/MinGW32/bin/g++-dw2.exe" to "g++.exe"

Since building Spring depends on the tool dos2unix, not provided by TDM, add cygutils-dos2unix from https://sourceforge.net/projects/mingw/files/MinGW/cygutils/, and libpopt(dll) from https://sourceforge.net/projects/mingw/files/MinGW/popt/

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

===mingwlibs install directory===
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [http://cloud.github.com/downloads/spring/spring/spring-vc8libs-v5.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-05-04T23:12:31Z

Cranphin: /* TDM webinstaller */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

= Essential Tools and Libraries =
If you are new to programming for open-source projects on Windows you'll quickly discover it can often be difficult to find the right software and dependencies. To aid you in your journey you will find stable versions of most of the tools and libraries listed below on [http://www.warriorhut.org/spring this mirror]. Use them if you have trouble finding what you need below.

If you have trouble opening any of the archives please install the application 7zip as it supports all of the archive formats in common use (it's in the tools/archiving subdirectory).

= Compiling on Windows =
For other platforms see [[Building spring]].

==Install MinGW==
Compiling Spring in MinGW requires GCC 4.x 
Because the official MinGW installer & packages are totally outdated and abandoned, we recommend to use the TDM ones instead:

===TDM webinstaller===
Get it here: [http://tdm-gcc.tdragon.net/download TDM-MinGW] (download the webinstaller alias "On-Demand Installer")

Get at least the following packages:
* gcc (version dw/dwarf2!)
** core
** g++
* binutils
* mingw-runtime
* win32api

* gdb (recommended for debugging)
* openmp (optional)

If you get undefined ... _Unwind_Resume linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2''.

When using ''dwarf2'' as suggested, the compilers will be named abc-dw2. Rename (atleast) these two, or CMake will fail:
* "C:/MinGW32/bin/gcc-dw2.exe" to "gcc.exe"
* "C:/MinGW32/bin/g++-dw2.exe" to "g++.exe"

Since building Spring depends on the tool dos2unix, not provided by TDM, add cygutils-dos2unix from https://sourceforge.net/projects/mingw/files/MinGW/cygutils/, and libpopt(dll) from https://sourceforge.net/projects/mingw/files/MinGW/popt/

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

===mingwlibs install directory===
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [http://cloud.github.com/downloads/spring/spring/spring-vc8libs-v5.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-05-04T23:11:19Z

Cranphin: /* TDM webinstaller */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

= Essential Tools and Libraries =
If you are new to programming for open-source projects on Windows you'll quickly discover it can often be difficult to find the right software and dependencies. To aid you in your journey you will find stable versions of most of the tools and libraries listed below on [http://www.warriorhut.org/spring this mirror]. Use them if you have trouble finding what you need below.

If you have trouble opening any of the archives please install the application 7zip as it supports all of the archive formats in common use (it's in the tools/archiving subdirectory).

= Compiling on Windows =
For other platforms see [[Building spring]].

==Install MinGW==
Compiling Spring in MinGW requires GCC 4.x 
Because the official MinGW installer & packages are totally outdated and abandoned, we recommend to use the TDM ones instead:

===TDM webinstaller===
Get it here: [http://tdm-gcc.tdragon.net/download TDM-MinGW] (download the webinstaller alias "On-Demand Installer")

Get at least the following packages:
* gcc (version dw/dwarf2!)
** core
** g++
* binutils
* mingw-runtime
* win32api

* gdb (recommended for debugging)
* openmp (optional)

If you get undefined ... _Unwind_Resume linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2''.

When using ''dwarf2'' as suggested, the compilers will be named abc-dw2. Rename (atleast) these two, or CMake will fail:
* "C:/MinGW32/bin/gcc-dw2.exe" to "gcc.exe"
* "C:/MinGW32/bin/g++-dw2.exe" to "g++.exe"

Since building Spring depends on the tool dos2unix, not provided by TDM, add cygutils-dos2unix from https://sourceforge.net/projects/mingw/files/MinGW/cygutils/cygutils-1.3.4-1/, and libpopt(dll) from https://sourceforge.net/projects/mingw/files/MinGW/popt/popt-1.15-1/

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

===mingwlibs install directory===
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [http://cloud.github.com/downloads/spring/spring/spring-vc8libs-v5.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-05-04T22:54:46Z

Cranphin: /* TDM webinstaller */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

= Essential Tools and Libraries =
If you are new to programming for open-source projects on Windows you'll quickly discover it can often be difficult to find the right software and dependencies. To aid you in your journey you will find stable versions of most of the tools and libraries listed below on [http://www.warriorhut.org/spring this mirror]. Use them if you have trouble finding what you need below.

If you have trouble opening any of the archives please install the application 7zip as it supports all of the archive formats in common use (it's in the tools/archiving subdirectory).

= Compiling on Windows =
For other platforms see [[Building spring]].

==Install MinGW==
Compiling Spring in MinGW requires GCC 4.x 
Because the official MinGW installer & packages are totally outdated and abandoned, we recommend to use the TDM ones instead:

===TDM webinstaller===
Get it here: [http://tdm-gcc.tdragon.net/download TDM-MinGW] (download the webinstaller alias "On-Demand Installer")

Get at least the following packages:
* gcc (version dw/dwarf2!)
** core
** g++
* binutils
* mingw-runtime
* win32api

* gdb (recommended for debugging)
* openmp (optional)

If you get undefined ... _Unwind_Resume linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2''.

When using ''dwarf2'' as suggested, you'll have to point CMake to the correct compilers. The first time you run CMake against the spring source you should get a dialog in which you can select "Specify native compilers". Select that, then browse to the correct c and c++ compilers, usually this will be: "C:/MinGW32/bin/gcc-dw2.exe" and "C:/MinGW32/bin/g++-dw2.exe".
Note: this seems not enough, windres.exe still tries to use the wrong gcc path.

Since building Spring depends on the tool dos2unix, not provided by TDM, add cygutils-dos2unix from https://sourceforge.net/projects/mingw/files/MinGW/cygutils/cygutils-1.3.4-1/, and libpopt(dll) from https://sourceforge.net/projects/mingw/files/MinGW/popt/popt-1.15-1/

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

===mingwlibs install directory===
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [http://cloud.github.com/downloads/spring/spring/spring-vc8libs-v5.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Building Spring on Windows

2011-05-04T22:53:40Z

Cranphin: /* TDM webinstaller */

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}
= Get the Source Code =
{{Obtaining_The_Source_Code}}

= Essential Tools and Libraries =
If you are new to programming for open-source projects on Windows you'll quickly discover it can often be difficult to find the right software and dependencies. To aid you in your journey you will find stable versions of most of the tools and libraries listed below on [http://www.warriorhut.org/spring this mirror]. Use them if you have trouble finding what you need below.

If you have trouble opening any of the archives please install the application 7zip as it supports all of the archive formats in common use (it's in the tools/archiving subdirectory).

= Compiling on Windows =
For other platforms see [[Building spring]].

==Install MinGW==
Compiling Spring in MinGW requires GCC 4.x 
Because the official MinGW installer & packages are totally outdated and abandoned, we recommend to use the TDM ones instead:

===TDM webinstaller===
Get it here: [http://tdm-gcc.tdragon.net/download TDM-MinGW] (download the webinstaller alias "On-Demand Installer")

Get at least the following packages:
* gcc (version dw/dwarf2!)
** core
** g++
* binutils
* mingw-runtime
* win32api

* gdb (recommended for debugging)
* openmp (optional)

If you get undefined ... _Unwind_Resume linking errors, deinstall ''whole'' TDM/MinGW and reinstall it with ''dwarf2''.

When using ''dwarf2'' as suggested, you'll have to point CMake to the correct compilers. The first time you run CMake against the spring source you should get a dialog in which you can select "Specify native compilers". Select that, then browse to the correct c and c++ compilers, usually this will be: "C:/MinGW32/bin/gcc-dw2.exe" and "C:/MinGW32/bin/g++-dw2.exe".
Note: this seems not enough, winres.exe still tries to use the wrong gcc path.

Since building Spring depends on the tool dos2unix, not provided by TDM, add cygutils-dos2unix from https://sourceforge.net/projects/mingw/files/MinGW/cygutils/cygutils-1.3.4-1/, and libpopt(dll) from https://sourceforge.net/projects/mingw/files/MinGW/popt/popt-1.15-1/

==Spring MinGW Dependencies (mingwlibs)==
You also need some Spring dependencies, prepackaged in the '''mingwlibs''' archive.

You can download a tarball [http://github.com/spring/mingwlibs '''here'''] ('''Download Source''' button). 
Or (recommended) use git:
* open a console (cmd.exe) or use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your source dir
* make a dir named mingwlibs
* <code>cd mingwlibs</code>
* run <code>git clone git://github.com/spring/mingwlibs.git</code>
* and update it from time to time with: <code>git pull --rebase</code>

===mingwlibs install directory===
There are two ways to setup the MinGW libraries:

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

= Compiling with cmake =
First get [http://www.cmake.org/cmake/resources/software.html CMake here] and install it.

then
* run the ''cmake-gui'' and select a source and a build directory
* configure and follow the instructions, and adjust variables to your needs (defaults are OK)
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your build directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code>
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>

=Compiling with scons=
deprecated - use cmake

=Visual Studio 8 (2005)=
(possibly the free Express Edition)

* Install the [http://cloud.github.com/downloads/spring/spring/spring-vc8libs-v5.7z vclibs library package]. You need to install this in the /spring directory from the SVN checkout or the zipped source. If done right, it will look like:
**/spring/
**/spring/installer
**/spring/rts
**/spring/... other dirs
**/spring/vclibs
* Install the [http://msdn.microsoft.com/directx/sdk/ DirectX SDK]
* Install the PlatformSDK. I got away with unchecking the parts of the PlatformSDK that were obviously not related (IIS, web stuff). Makes for a smaller download. Make '''sure''' the Platform SDK and DirectX SDK are in the VS search/include directories.
** Note that the most recent version of Platform SDK is called [http://www.microsoft.com/downloads/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Windows SDK].
* After installing them, open Visual C++. Click Tools >> Options >> Projects and Solutions >> VC++ Directories. Add these entries to the corresponding sections (paths just a reference, yours may be different):
**Include files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Include
***$(ProgramFiles)\Microsoft Platform SDK\include
**Library files:
***$(ProgramFiles)\Microsoft DirectX SDK (August 2007)\Lib\x86 (Might need \x64 on a 64-bit platform, I don't know.)
***$(ProgramFiles)\Microsoft Platform SDK\lib
* Open the solution. /spring/rts/build/vstudio8/rts.sln
* Start building (usually you want to select the release/no debug build, debug is really too slow and is used only when you really know what you want to test)
* Select the working directory in the project properties, otherwise spring will not work correctly

== Errors ==
* ...\Windows\v6.0A\include\shlwapi.h(196) : error C2061: syntax error : identifier 'PCUITEMID_CHILD' - wrong version of Platform SDK is used; go to Tools >> Options >> >> Projects and Solutions >> VC++ Directories and move the one that's causing this problem all the way down.

=Visual Studio 9 (2008)=
(possibly the free Express Edition)

Not yet fully working as far as I know; you need at least this hotfix from Microsoft though:

http://support.microsoft.com/kb/946040

or update your Visual Studio using your Windows Update.

For the rest the Visual Studio 8 instructions should apply, mostly. You probably won't need to add Windows SDK path references as they should be present by default.

You need the [http://cloud.github.com/downloads/spring/spring/spring-vc9libs-v4.7z vclibs for VS2008], and not the ones for Visual Studio 2005. The installation procedure is the same though.

Be aware that the project file isn't updated nearly as frequently as it should, so it's best to use the .vcproj file from VS8 build and VS2008 will automatically update it.

=General Visual Studio Notes=
So far the following aspects of Spring don't function properly or don't function at all when compiled with Visual Studio:
*Your VS build won't sync with GCC builds in multiplayer mode
*Any external AI crashes immediatley at start, LUA AI works though
[[Category:Compiling]]

Crans Building Spring on Windows Log

2011-04-30T15:25:41Z

Cranphin:

Right, the current building on windows with MinGW instructions for master seem outdated/broken/etc. :)

Since the new MinGW versions, things have become easier and more reliable.
So to help others, I'll log here how I can make a working windows build from scratch.

I know this initial page isn't well formatted, I'll leave that to when I feel like it, or someone else does. Right now it seems more important to have some working instructions.

I can't test on anything other then my own system, which is Windows7, 64 bit.
The date of all this is April 30, 2011.

Although this builds, and runs, you may have issues, since it is master. I certainly have some :) But since the buildbot windows builds have the same issues at the moment, I assume this is due to master having some issues, and not the build procedure.

Keep in mind that these steps describe using the latest available versions of everything. Currently this works pretty well, and is by far the easiest. But this may certainly change in the future.

Steps:
* For the Java AI bits, you'll want to have a 32 bit JDK installed, I'm currently using jdk1.6.0_24. Things may build without, but I'm doing a Java AI, so not gonna test without Java :)
* You'll need a working MinGW, this used to be a pain, but with recent updates this has become a lot better.
** Read the page on http://www.mingw.org/wiki/Getting_Started, just to get your bearings.
** Grab the lastest mingw-get-inst from http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst. I'm using mingw-get-inst-20110316.exe.
** Run the installer, choose to download the latest repository catalogues, accept the license
** I'd recommend using the default install location of C:\MinGW, check if you didn't already have something there before installing :)
** Whether you create start menu folders/desktop links/etc. is up to you.
** From the available packages, select at least C++ compiler, adding MinGW Developer Toolkit works quite well, but is a rather big download. Not adding it means we need to add some more packages later.
** Now the installer will do it's work, this will take some time. I usually get some errors/warnings about files which couldn't be downloaded (sourceforge hickups I figure), but as far as I can tell it'll retry them.
** You'll need to add the bin sub folder where you installed MinGW to the PATH environment variable, most reading this will know what to do, otherwise the MinGW getting started page covers it well.
** If all went well, you should now have some working tools. Open a cmd.exe (windows command shell), and type 'g++ --version', this should tell you you've now got a 4.5.2 or higher g++ compiler.
** Spring needs the dos2unix tool to build, which is not installed by default. Use the command 'mingw-get install cygutils-dos2unix' to grab it.
** If you did not install the MinGW Developer Toolkit, you'll have to install mingw32-make, use: 'mingw-get install mingw32-make'
** Because of a 'bug' (See https://sourceforge.net/tracker/?func=detail&aid=3295175&group_id=2435&atid=102435), we'll have to replace the installed collect2.exe. Get the gcc-4.5.2-tdm-1-core.zip from: https://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%204.5%20series/4.5.2-tdm-1%20SJLJ/ (or a newer version in the same location. These are TDM MinGW builds, alternative builds of MinGW, and he's got a fix in for this issue), unpack the zip file to a temporary location, and copy the contained libexec\gcc\mingw32\4.5.2\collect2.exe to C:\MinGW\libexec\gcc\mingw32\4.5.2 or similar, replacing the existing collect2.exe. Hopefully they'll do something with the bug report and fix this :)
* I'm assuming you'll want to use git to get master, so you'll need the git client.
** Get the latest client from: http://code.google.com/p/msysgit/downloads/list Currently the most recent is 'Git-1.7.4-preview20110204.exe', detailing all the settings is a bit out of scope here, I have found that choosing for it to do no newline conversions tends to work the best with Spring :)
** We'll get the source now, start with 'git clone git://github.com/spring/spring.git' This will create a 'spring' folder in the folder you execute the command from. This spring folder will contain the source.
** If at a later time you want to update this source, go to the spring folder, and use 'git pull --rebase'.
* Ok, we're nearly done, we now need the 'mingwlibs', our own collection of libraries and stuff needed to build on windows. Your best bet is to get it from https://github.com/spring/mingwlibs (which always is the most recent, we need the latest for master), it has a big Downloads button. Use that to get a zip, and put the zip's content under out spring folder, in a subfolder 'mingwlibs'.
* Well, nearlyish, we need CMake now, get and install the latest from http://www.cmake.org/cmake/resources/software.html. 2.8.4 works fine for me atm.
* Now run cmake-ui (it should have put a icon on the desktop).
** Select the source folder, it's the spring folder you got with git.
** Choose a build folder, it doesn't have to exist yet, I use a 'build' folder next to the 'spring' folder.
** Hit the configure button. Use defaults in the generator dialog, which should be MinGW Makefiles, and use default native compilers.
** There's now lots of configuration values, luckily defaults work fine normally. The only change I'd recommend is to change CMAKE_INSTALL_PREFIX to something like 'C:/Spring.master' Windows7/VIsta do not like anyone changing stuff under the Program Files folder, so keep spring in the root of C: (or so) tends to prevent a lot of problems. If you've changed anything, hit configure once more.
** Now hit generate, this should create all needed makefiles and stuff.
** If that went well, we're done with CMake, close it.
* Open a new cmd.exe, and go to the new 'build' folder.
* Optionally, type 'set MAKE_COMMAND=mingw32-make -j2', if you have more then one core and want to try multi-processed building (it's faster).
* Cross your fingers and type 'mingw32-make install DESTDIR=C:\' (the DESTDIR part will heed the 'CMAKE_INSTALL_PREFIX' you set earlier).

If things build well, one way to testing things is:
* Get the BA mod from: http://spring-portal.com/index.php/docman/doc_details/314-balanced-annihilation-v71
* Get and install abma's test 'game' from: https://github.com/abma/spring-test-game (you want all contents as zip, the big download button). There's a README included.
* Now start spring.exe, pick a map of your liking, set the 'ai' to Commanders (which only spawns an idle commander for each side), and pick the game/mod name 'Balanced Annihilation modtest-V7.31' notice the 'modtest' bit :)

[[Category:Compiling]]

Crans Building Spring on Windows Log

2011-04-30T15:01:41Z

Cranphin:

Right, the current building on windows with MinGW instructions for master seem outdated/broken/etc. :)

Since the new MinGW versions, things have become easier and more reliable.
So to help others, I'll log here how I can make a working windows build from scratch.

I know this initial page isn't well formatted, I'll leave that to when I feel like it, or someone else does. Right now it seems more important to have some working instructions.

I can't test on anything other then my own system, which is Windows7, 64 bit.
The date of all this is April 30, 2011.

Although this builds, and runs, you may have issues, since it is master. I certainly have some :) But since the buildbot windows builds have the same issues at the moment, I assume this is due to master having some issues, and not the build procedure.

Keep in mind that these steps describe using the latest available versions of everything. Currently this works pretty well, and is by far the easiest. But this may certainly change in the future.

Steps:
- For the Java AI bits, you'll want to have a 32 bit JDK installed, I'm currently using jdk1.6.0_24. Things may build without, but I'm doing a Java AI, so not gonna test without Java :)
- You'll need a working MinGW, this used to be a pain, but with recent updates this has become a lot better.
- Read the page on http://www.mingw.org/wiki/Getting_Started, just to get your bearings.
- Grab the lastest mingw-get-inst from http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst. I'm using mingw-get-inst-20110316.exe.
- Run the installer, choose to download the latest repository catalogues, accept the license
- I'd recommend using the default install location of C:\MinGW, check if you didn't already have something there before installing :)
- Whether you create start menu folders/desktop links/etc. is up to you.
- From the available packages, select at least C++ compiler, adding MinGW Developer Toolkit works quite well, but is a rather big download. Not adding it means we need to add some more packages later.
- Now the installer will do it's work, this will take some time. I usually get some errors/warnings about files which couldn't be downloaded (sourceforge hickups I figure), but as far as I can tell it'll retry them.
- You'll need to add the bin sub folder where you installed MinGW to the PATH environment variable, most reading this will know what to do, otherwise the MinGW getting started page covers it well.
- If all went well, you should now have some working tools. Open a cmd.exe (windows command shell), and type 'g++ --version', this should tell you you've now got a 4.5.2 or higher g++ compiler.
- Spring needs the dos2unix tool to build, which is not installed by default. Use the command 'mingw-get install cygutils-dos2unix' to grab it.
- If you did not install the MinGW Developer Toolkit, you'll have to install mingw32-make, use: 'mingw-get install mingw32-make'
- Because of a 'bug' (See https://sourceforge.net/tracker/?func=detail&aid=3295175&group_id=2435&atid=102435), we'll have to replace the installed collect2.exe. Get the gcc-4.5.2-tdm-1-core.zip from: https://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%204.5%20series/4.5.2-tdm-1%20SJLJ/ (or a newer version in the same location. These are TDM MinGW builds, alternative builds of MinGW, and he's got a fix in for this issue), unpack the zip file to a temporary location, and copy the contained libexec\gcc\mingw32\4.5.2\collect2.exe to C:\MinGW\libexec\gcc\mingw32\4.5.2 or similar, replacing the existing collect2.exe. Hopefully they'll do something with the bug report and fix this :)
- I'm assuming you'll want to use git to get master, so you'll need the git client.
- Get the latest client from: http://code.google.com/p/msysgit/downloads/list Currently the most recent is 'Git-1.7.4-preview20110204.exe', detailing all the settings is a bit out of scope here, I have found that choosing for it to do no newline conversions tends to work the best with Spring :)
- We'll get the source now, start with 'git clone git://github.com/spring/spring.git' This will create a 'spring' folder in the folder you execute the command from. This spring folder will contain the source.
- If at a later time you want to update this source, go to the spring folder, and use 'git pull --rebase'.
- Ok, we're nearly done, we now need the 'mingwlibs', our own collection of libraries and stuff needed to build on windows. Your best bet is to get it from https://github.com/spring/mingwlibs (which always is the most recent, we need the latest for master), it has a big Downloads button. Use that to get a zip, and put the zip's content under out spring folder, in a subfolder 'mingwlibs'.
- Well, nearlyish, we need CMake now, get and install the latest from http://www.cmake.org/cmake/resources/software.html. 2.8.4 works fine for me atm.
- Now run cmake-ui (it should have put a icon on the desktop).
- Select the source folder, it's the spring folder you got with git.
- Choose a build folder, it doesn't have to exist yet, I use a 'build' folder next to the 'spring' folder.
- Hit the configure button. Use defaults in the generator dialog, which should be MinGW Makefiles, and use default native compilers.
- There's now lots of configuration values, luckily defaults work fine normally. The only change I'd recommend is to change CMAKE_INSTALL_PREFIX to something like 'C:/Spring.master' Windows7/VIsta do not like anyone changing stuff under the Program Files folder, so keep spring in the root of C: (or so) tends to prevent a lot of problems. If you've changed anything, hit configure once more.
- Now hit generate, this should create all needed makefiles and stuff.
- If that went well, we're done with CMake, close it.
- Open a new cmd.exe, and go to the new 'build' folder.
- Optionally, type 'set MAKE_COMMAND=mingw32-make -j2', if you have more then one core and want to try multi-processed building (it's faster).
- Cross your fingers and type 'mingw32-make install DESTDIR=C:\' (the DESTDIR part will heed the 'CMAKE_INSTALL_PREFIX' you set earlier).

If things build well, one way to testing things is:
- Get the BA mod from: http://spring-portal.com/index.php/docman/doc_details/314-balanced-annihilation-v71
- Get and install abma's test 'game' from: https://github.com/abma/spring-test-game (you want all contents as zip, the big download button). There's a README included.
- Now start spring.exe, pick a map of your liking, set the 'ai' to Commanders (which only spawns an idle commander for each side), and pick the game/mod name 'Balanced Annihilation modtest-V7.31' notice the 'modtest' bit :)

Crans Building Spring on Windows Log

2011-04-30T11:08:14Z

Cranphin: Created page with "Right, the current building on windows with MinGW instructions for master seem outdated/broken/etc. :) Since the new MinGW versions, things have become easier and more reliable...."

Right, the current building on windows with MinGW instructions for master seem outdated/broken/etc. :)

Since the new MinGW versions, things have become easier and more reliable.
So to help others, I'll log here how I can make a working windows build from scratch.

I know this initial page isn't well formatted, I'll leave that to when I feel like it, or someone else does. Right now it seems more important to have some working instructions.

I can't test on anything other then my own system, which is Windows7, 64 bit.
The date of all this is April 30, 2011.

Although this builds, and runs, current master seems a bit wobbly to say the least, AI's wont run for me, shadows slow everything way down (which they didn't use to), getting lua out of memory stuff :)
But since the buildbot windows builds have the same issues at the moment, I assume this is due to master having some issues, and not the build procedure.

Keep in mind that these steps describe using the latest available versions of everything. Currently this works pretty well, and is by far the easiest. But this may certainly change in the future.

Steps:
- For the Java AI bits, you'll want to have a 32 bit JDK installed, I'm currently using jdk1.6.0_24. Things may build without, but I'm doing a Java AI, so not gonna test without Java :)
- You'll need a working MinGW, this used to be a pain, but with recent updates this has become a lot better.
- Read the page on http://www.mingw.org/wiki/Getting_Started, just to get your bearings.
- Grab the lastest mingw-get-inst from http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst. I'm using mingw-get-inst-20110316.exe.
- Run the installer, choose to download the latest repository catalogues, accept the license
- I'd recommend using the default install location of C:\MinGW, check if you didn't already have something there before installing :)
- Whether you create start menu folders/desktop links/etc. is up to you.
- From the available packages, select at least C++ compiler, adding MinGW Developer Toolkit works quite well, but is a rather big download. Not adding it means we need to add some more packages later.
- Now the installer will do it's work, this will take some time. I usually get some errors/warnings about files which couldn't be downloaded (sourceforge hickups I figure), but as far as I can tell it'll retry them.
- You'll need to add the bin sub folder where you installed MinGW to the PATH environment variable, most reading this will know what to do, otherwise the MinGW getting started page covers it well.
- If all went well, you should now have some working tools. Open a cmd.exe (windows command shell), and type 'g++ --version', this should tell you you've now got a 4.5.2 or higher g++ compiler.
- Spring needs the dos2unix tool to build, which is not installed by default. Use the command 'mingw-get install cygutils-dos2unix' to grab it.
- If you did not install the MinGW Developer Toolkit, you'll have to install mingw32-make, use: 'mingw-get install mingw32-make'
- Because of a 'bug' (See https://sourceforge.net/tracker/?func=detail&aid=3295175&group_id=2435&atid=102435), we'll have to replace the installed collect2.exe. Get the gcc-4.5.2-tdm-1-core.zip from: https://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%204.5%20series/4.5.2-tdm-1%20SJLJ/ (or a newer version in the same location. These are TDM MinGW builds, alternative builds of MinGW, and he's got a fix in for this issue), unpack the zip file to a temporary location, and copy the contained libexec\gcc\mingw32\4.5.2\collect2.exe to C:\MinGW\libexec\gcc\mingw32\4.5.2 or similar, replacing the existing collect2.exe. Hopefully they'll do something with the bug report and fix this :)
- I'm assuming you'll want to use git to get master, so you'll need the git client.
- Get the latest client from: http://code.google.com/p/msysgit/downloads/list Currently the most recent is 'Git-1.7.4-preview20110204.exe', detailing all the settings is a bit out of scope here, I have found that choosing for it to do no newline conversions tends to work the best with Spring :)
- We'll get the source now, start with 'git clone git://github.com/spring/spring.git' This will create a 'spring' folder in the folder you execute the command from. This spring folder will contain the source.
- If at a later time you want to update this source, go to the spring folder, and use 'git pull --rebase'.
- Ok, we're nearly done, we now need the 'mingwlibs', our own collection of libraries and stuff needed to build on windows. Your best bet is to get it from https://github.com/spring/mingwlibs (which always is the most recent, we need the latest for master), it has a big Downloads button. Use that to get a zip, and put the zip's content under out spring folder, in a subfolder 'mingwlibs'.
- Well, nearlyish, we need CMake now, get and install the latest from http://www.cmake.org/cmake/resources/software.html. 2.8.4 works fine for me atm.
- Now run cmake-ui (it should have put a icon on the desktop).
- Select the source folder, it's the spring folder you got with git.
- Choose a build folder, it doesn't have to exist yet, I use a 'build' folder next to the 'spring' folder.
- Hit the configure button. Use defaults in the generator dialog, which should be MinGW Makefiles, and use default native compilers.
- There's now lots of configuration values, luckily defaults work fine normally. The only change I'd recommend is to change CMAKE_INSTALL_PREFIX to something like 'C:/Spring.master' Windows7/VIsta do not like anyone changing stuff under the Program Files folder, so keep spring in the root of C: (or so) tends to prevent a lot of problems. If you've changed anything, hit configure once more.
- Now hit generate, this should create all needed makefiles and stuff.
- If that went well, we're done with CMake, close it.
- Open a new cmd.exe, and go to the new 'build' folder.
- Optionally, type 'set MAKE_COMMAND=mingw32-make -j2', if you have more then one core and want to try multi-processed building (it's faster).
- Cross your fingers and type 'mingw32-make install DESTDIR=C:\' (the DESTDIR part will heed the 'CMAKE_INSTALL_PREFIX' you set earlier).