EngineSource for GameDevs - Revision history

Knorke: /* Intro */ bit clearer

2014-04-29T23:21:32Z

Intro: bit clearer

← Older revision		Revision as of 00:21, 30 April 2014
Line 1:		Line 1:
	==Intro==		==Intro==
	During creation of a Spring game you will soon notice that not ~~everything~~ is documented.		During creation of a Spring game you will soon notice that not every detail is documented.
	~~Fortunately, the engine is open source and thus some~~ things can be ~~figured out by~~ looking at ~~it. Wait, isn't that like, super cryptic? Yes, scroll past those parts~~. ~~A few things~~ are ~~comprehensible~~.		The most common things can be done without ever looking at the engine. But sometimes there are some specifique questions where one wants more details.

			Fortunately, the engine is open source and thus some things can be figured out by looking at it. Wait, isn't that like, super cryptic? Yes, scroll past those parts. A few things are comprehensible.

	==Downloading source and opening the files==		==Downloading source and opening the files==

Flozi: Game development -> Game Dev (Still useful?)

2013-03-25T20:13:18Z

Game development -> Game Dev (Still useful?)

← Older revision		Revision as of 21:13, 25 March 2013
Line 55:		Line 55:
	https://github.com/spring/spring/blob/develop/rts/Sim/Units/Unit.cpp		https://github.com/spring/spring/blob/develop/rts/Sim/Units/Unit.cpp

	[[Category:Game ~~development~~]]		[[Category:Game Dev]]

Flozi: Category:Game development -- deprecated?

2013-03-08T21:15:41Z

Category:Game development -- deprecated?

← Older revision		Revision as of 22:15, 8 March 2013
Line 54:		Line 54:
	Unit actions (damage, kill, experience,...):<br>		Unit actions (damage, kill, experience,...):<br>
	https://github.com/spring/spring/blob/develop/rts/Sim/Units/Unit.cpp		https://github.com/spring/spring/blob/develop/rts/Sim/Units/Unit.cpp

			[[Category:Game development]]

Abq911: Typos

2012-08-12T23:41:30Z

Typos

← Older revision		Revision as of 00:41, 13 August 2012
Line 1:		Line 1:
	==Intro==		==Intro==
	During creation of a Spring game you will soon notice that not everything is ~~documentated~~.		During creation of a Spring game you will soon notice that not everything is documented.
	Fortunately, the engine is open source and thus some things can be figured out by looking at it. Wait, isn't that like, super cryptic? Yes, scroll past those parts. A few things are ~~comprehendible~~.		Fortunately, the engine is open source and thus some things can be figured out by looking at it. Wait, isn't that like, super cryptic? Yes, scroll past those parts. A few things are comprehensible.


	==~~downloading~~ source and opening the files==		==Downloading source and opening the files==
	Download this https://github.com/spring/spring/zipball/master and unpack the zip file.		Download this https://github.com/spring/spring/zipball/master and unpack the zip file.

Line 36:		Line 36:


	==~~searching~~ text in files==		==Searching text in files==
	It is usefull to have an text editor that can search for text in multiple files at once, for example this one: http://notepad-plus-plus.org/		It is usefull to have an text editor that can search for text in multiple files at once, for example this one: http://notepad-plus-plus.org/

	==~~Interessting~~ files==		==Interesting files==
	Most things outside "Sim" folder are ~~uninteressting~~.		Most things outside "Sim" folder are uninteresting.

	The files where XY'''defs''' get loaded:		The files where XY'''defs''' get loaded:

Knorke at 15:08, 14 December 2011

2011-12-14T15:08:37Z

← Older revision		Revision as of 16:08, 14 December 2011
Line 1:		Line 1:
	==Intro==		==Intro==
	During creation of a Spring game you will soon notice that not everything is documentated.		During creation of a Spring game you will soon notice that not everything is documentated.
	Fortunately, the engine is open source and thus some things can be figured out by looking at it.		Fortunately, the engine is open source and thus some things can be figured out by looking at it. Wait, isn't that like, super cryptic? Yes, scroll past those parts. A few things are comprehendible.

	~~Wait, isn't that like, super cryptic? Yes, scroll past those parts~~.
	~~A few things are comprehendible~~.		==downloading source and opening the files==
			Download this https://github.com/spring/spring/zipball/master and unpack the zip file.

	==Text==		==Text==
Line 33:		Line 34:

	'''GetFloat3''' - 3 floats, for example coordinates in case of "modelCenterOffset" or a vector in case of "flareDropVector"		'''GetFloat3''' - 3 floats, for example coordinates in case of "modelCenterOffset" or a vector in case of "flareDropVector"


			==searching text in files==
			It is usefull to have an text editor that can search for text in multiple files at once, for example this one: http://notepad-plus-plus.org/

	==Interessting files==		==Interessting files==

Knorke: created page, not if worth to continue?

2011-12-01T18:31:56Z

created page, not if worth to continue?

New page

==Intro==
During creation of a Spring game you will soon notice that not everything is documentated.
Fortunately, the engine is open source and thus some things can be figured out by looking at it.

Wait, isn't that like, super cryptic? Yes, scroll past those parts.
A few things are comprehendible.

==Text==
For example the code to load UnitDefs can be found here:
https://github.com/spring/spring/blob/develop/rts/Sim/Units/UnitDef.cpp

Scroll down to about line 270:<br>
Notice how there are lines like for example this:

<code>metalStorage = udTable.GetFloat("metalStorage", 0.0f);</code>

The word in double quotes ("metalStorage") is the UnitDef tag as it is read from the unit file.

If a tag can not be found in this file in this form, it is very likely that it does nothing and you can remove it from the unit file.

GetFloat means that this tag is a float number.
The number, in this case 0.0f, is the default value that is used, when the tag can not be found in the unit file.

Since the engine expects a number (eg 100.0) it is understandable that metalStorage = "a lot", or metalStorage=false will not work.

Beside '''GetFloat''' there are:

'''GetBool''' - true or false

'''GetInt''' - an integer number

'''GetString''' - a string, that means a word eg a unit name or a file name

'''GetFloat3''' - 3 floats, for example coordinates in case of "modelCenterOffset" or a vector in case of "flareDropVector"

==Interessting files==
Most things outside "Sim" folder are uninteressting.

The files where XY'''defs''' get loaded:

https://github.com/spring/spring/blob/develop/rts/Sim/Units/UnitDef.cpp

https://github.com/spring/spring/blob/develop/rts/Sim/Weapons/WeaponDefHandler.cpp

https://github.com/spring/spring/blob/develop/rts/Sim/Features/FeatureHandler.cpp

https://github.com/spring/spring/blob/develop/rts/Sim/MoveTypes/MoveInfo.cpp

Unit actions (damage, kill, experience,...):<br>
https://github.com/spring/spring/blob/develop/rts/Sim/Units/Unit.cpp