Building spring - Revision history

Hoijui at 20:20, 11 July 2010

2010-07-11T20:20:37Z

← Older revision		Revision as of 21:20, 11 July 2010
Line 3:		Line 3:
	=Building Spring=		=Building Spring=

	== ~~Obtaining the Source~~ ==		== Compiling ==
	~~{{Obtaining_The_Source_Code}}~~

	~~== Compiling ==~~
	* [[Building Spring on Windows\|Windows]]		* [[Building Spring on Windows\|Windows]]
	* [[Building Spring on Linux\|Linux]]		* [[Building Spring on Linux\|Linux]]
			* [[Building Spring Cross Compiled\|Cross-compiler]]
	* [[Building Spring on MacOSX\|MacOSX]]		* [[Building Spring on MacOSX\|MacOSX]]
	* [[Building Spring Cross Compiled\|Cross-compiler]]		* [[Building Spring on Buildbot\|Buildbot]]
	* [[Building Spring on Buildbot\|Buildbot]].

	If you are using Linux and prefer to use your distributions package system, refer to the Linux [[SetupGuide]].		If you are using Linux and prefer to use your distributions package system, refer to the Linux [[SetupGuide]].

	[[Category:Compiling]]		[[Category:Compiling]]

Aegis at 16:35, 31 August 2009

2009-08-31T16:35:07Z

← Older revision		Revision as of 17:35, 31 August 2009
Line 1:		Line 1:
	[[Engine_Development\|Development]] < ~~Building Spring~~		[[Engine_Development\|Development]] < {{FULLPAGENAME}}

	=Building Spring=		=Building Spring=

Aegis at 16:14, 31 August 2009

2009-08-31T16:14:27Z

← Older revision		Revision as of 17:14, 31 August 2009
Line 1:		Line 1:
			[[Engine_Development\|Development]] < Building Spring

	=Building Spring=		=Building Spring=

Spliff: getting source info changed to a template

2009-02-14T02:00:02Z

getting source info changed to a template

← Older revision		Revision as of 03:00, 14 February 2009
Line 2:		Line 2:

	== Obtaining the Source ==		== Obtaining the Source ==
	~~Our GIT repository can be cloned from git://github.com/spring/spring.git.~~		{{Obtaining_The_Source_Code}}

	Another option is to manually [http://spring.clan-sy.com/download.php download] it along with the latest released version of the game. However, for serious developers, a better way would be to download the source straight from the GIT repository. This will also allow you to make a patch out of the changes you make to the code, and send it to one of the developers with repository access.

	~~Assuming the GIT-commandline client is installed, you can clone the repository with~~
	~~<code>git clone git://github.com/spring/spring.git</code>~~
	~~and update it with~~
	~~<code>git pull</code>~~

	== Compiling ==		== Compiling ==

Spliff: moved windows build instructions to Building_Spring_on_Windows

2009-02-04T20:52:20Z

moved windows build instructions to Building_Spring_on_Windows

Show changes

Spliff: moved development section to own page

2009-02-04T20:23:57Z

moved development section to own page

← Older revision		Revision as of 21:23, 4 February 2009
Line 161:		Line 161:
	For the rest the Visual Studio 8 instructions should apply, mostly.		For the rest the Visual Studio 8 instructions should apply, mostly.

			[[Category:Compiling]]
	~~=Developing Spring=~~
	~~'''NOTE: Outlined below is information on assisting with the development of the Spring source itself. For information about developing a mod (units, widgets, maps, etc.) see the~~ [[~~Mod_and_Unit_development]] page.'''~~

	~~'''Even if you are developing a mod, it is highly recommended that you get the engine source. Engine source + full text search~~: ~~DO IT.'''~~

	~~==Starting Spring Development==~~
	~~To start development, you will need:~~
	~~#To read the [[Coding_Standards]]~~
	~~#The latest version of the source~~
	~~#A good code manipulation program~~
	#Compiling ~~your modified source (see instructions above)~~

	~~===Learning C++===~~
	~~You will need to know C++ to modify or understand Spring's source code. If you are interested in learning C++, see [[Learning_CPP]]~~

	However please note that badly designed code (code created by a C++ novice for example), even if working will likely not be included in the spring code. Spring is a large project, and therefore it is necessary to stay away from hack jobs and create general solutions to problems.

	~~===Keep track what others do===~~
	If you develop with others, you need to know what they do. You can browse the source [http://github.com/spring/spring/tree/master at our github-page], and there is a [http://github.com/feeds/spring/commits/spring/master commit newsfeed].

	~~===Source Code Documentation===~~
	~~A good place to start is [http://buildbot.no-ip.org/~buildbot/spring/doxygen the source code documentation].~~

	~~An explanation on how the code is executed in game can be found in the [[Spring Engine Code]]~~
	~~page.~~

	~~===Development Guidelines===~~
	Before starting to make modifications to the source, take a look at the [[development guidelines]] which outlines some important things to think about. To find something interesting to work on, look at [[SpringEngineTODO]]. You can also check the list of [[whois doing what]] to see what others are doing. If you do edit the code, please add [[Doxygen style comments]] to the code, which will then enhance the source code documentation.

	~~===How to get your code included===~~
	If you create something that you think should be included in the official source tree, you can report a "bug" in [http://spring.clan-sy.com/mantis/ mantis, our BTS]. Add your patch as attachment, and put "[patch]" in front of the subject, so it is easy for us to separate patches from bugs.

	~~It's also considered standard practice to post one's modifications in the [http://spring.clan-sy.com/phpbb/viewforum.php?f=12 development forum] and get feedback.~~

	~~===Spring Engine TODO list===~~
	~~There is a TODO list for developers who want to contribute to the engine itself:~~
	[[SpringEngineTODO]]. There is also a [http://spring.clan-sy.com/phpbb/viewforum.php?f=21 feature request forum], which may give you some ideas. Don't be overwhelmed by the sheer number of (silly) requests though!

	~~==Development links==~~
	* [http://planetspring.free.fr/spring/ Automatic installer builds (crosscompiled, mingw)]
	* [http://spring.jobjol.nl/show_file.php?id=860 Spring base content files]
	* [http://developer.berlios.de/projects/taspring-linux BerliOS project page (OLD)]
	* [http://spring.clan-sy.com/mantis Bug Tracking System]
	* [http://buildbot.no-ip.org:8010/ Buildbot]
	* [https://lists.berlios.de/mailman/listinfo/taspring-linux-commit Commit mailing list]
	* [http://spring.clan-sy.com/dl/spring-vc8libs.exe Development libraries for Visual Studio 2005]
	* [http://spring.jobjol.nl/show_file.php?id=1102 Development libraries for MinGW]
	* [http://sourceforge.net/projects/springrts SourceForge project page (OLD)]
	* [http://buildbot.no-ip.org/~buildbot/spring/stacktraceTranslator.php StackTrace Translator]
	* [https://spring.clan-sy.com/svn/spring/trunk/ Old Subversion repository]
	* [http://spring.clan-sy.com/dl/docs/unitsync/group__unitsync__api.html Unitsync API docs]

	~~[[Category:Development]] [[Category:Source development~~]]

Spliff: Major cleanup. This page was a freakin mess!

2009-02-03T09:36:11Z

Major cleanup. This page was a freakin mess!

Show changes

Auswaschbar at 15:05, 26 January 2009

2009-01-26T15:05:34Z

← Older revision		Revision as of 16:05, 26 January 2009
Line 87:		Line 87:
	* binutils		* binutils
	* win32api		* win32api
	Use [http://jobjol.nl/~~1626 v12~~ of the MinGW library package] if you have MinGW 4.		Use [http://jobjol.nl/1102 v13 of the MinGW library package] if you have MinGW 4.

	'''Compiling spring'''		'''Compiling spring'''

Hoijui at 20:12, 12 January 2009

2009-01-12T20:12:12Z

← Older revision		Revision as of 21:12, 12 January 2009
Line 92:		Line 92:

	There are two ways to setup the MinGL libraries:		There are two ways to setup the MinGL libraries:
	1. Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
			''1.'' 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/installer		*/spring/installer
Line 98:		Line 99:
	*/spring/... other dirs		*/spring/... other dirs
	*/spring/mingwlibs		*/spring/mingwlibs
	2. Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''mingwlibsdir'' option to SCons in the configure step (see further down, in the quick instructions).
			''2.'' Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''mingwlibsdir'' option to SCons in the configure step (see further down, in the quick instructions).

	These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already.		These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already.

Hoijui: explained mingwlibs location configuration possibility

2009-01-12T20:10:03Z

explained mingwlibs location configuration possibility

← Older revision		Revision as of 21:10, 12 January 2009
Line 91:		Line 91:
	'''Compiling spring'''		'''Compiling spring'''

	Make sure you install the ~~MinGW library~~ package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:		There are two ways to setup the MinGL libraries:
	**/spring/		1. Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
	**/spring/installer		*/spring/
	**/spring/rts		*/spring/installer
	**/spring/... other dirs		*/spring/rts
	**/spring/mingwlibs		*/spring/... other dirs
			*/spring/mingwlibs
			2. Install the package somewhere else (preferably outside of the source tree), and pass its location with the ''mingwlibsdir'' option to SCons in the configure step (see further down, in the quick instructions).

	These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already.		These programs are a must have if you want to compile Spring with MinGW, so install them now, if you don't have them already.