Gamedev:Structure - Revision history

Eronoobos: /* root of game folder */

2016-04-07T21:41:19Z

root of game folder

← Older revision		Revision as of 22:41, 7 April 2016
Line 17:		Line 17:
	==='''<code>root of game folder</code>'''===		==='''<code>root of game folder</code>'''===

	[[Modinfo.lua]] and can also contain [[Modoptions.lua]] ~~and~~ [[AI:Development:Lang:Lua\|LuaAI.lua]]		[[Modinfo.lua]] and can also contain [[Modoptions.lua]], [[AI:Development:Lang:Lua\|LuaAI.lua]], and [[springignore.txt]]

	==='''<code>anims\</code>'''<br>===		==='''<code>anims\</code>'''<br>===

Flozi: /* unittextures\ */ update link

2013-10-29T18:15:47Z

unittextures\: update link

← Older revision		Revision as of 19:15, 29 October 2013
Line 74:		Line 74:

	==='''<code>unittextures\</code>'''<br>===		==='''<code>unittextures\</code>'''<br>===
	.dds, .tga or .png image [[~~Units~~:Textures\|texture]] files.		.dds, .tga or .png image [[3DModels:Textures\|texture]] files.
	: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.		: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.

Flozi: re-structure (kinda ugly though)

2013-10-29T18:02:36Z

re-structure (kinda ugly though)

Flozi: Merge in Units:Files descriptions and some clean-up (more required!)

2013-10-29T17:57:36Z

Merge in Units:Files descriptions and some clean-up (more required!)

← Older revision		Revision as of 18:57, 29 October 2013
Line 29:		Line 29:

	=='''<code>features\</code>'''<br>==		=='''<code>features\</code>'''<br>==
	.lua ~~files~~ [[Gamedev:FeatureDefs\|~~that define features (wreckage~~ and such)]]		.lua [[Gamedev:FeatureDefs\|FeatureDef]] files
	Subfolders are allowed.		: Corpse and map-static feature definitions. The corpse files are similar to [[Gamedev:UnitDefs\|UnitDefs]] but usually contain a less data, such as what model to use as the wreckage, how much metal the wreck will give if reclaimed, etc. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files.Subfolders are allowed.

	=='''<code>gamedata\</code>'''<br>==		=='''<code>gamedata\</code>'''<br>==
Line 50:		Line 50:

	=='''<code>objects3d\</code>'''<br>==		=='''<code>objects3d\</code>'''<br>==
	[[~~Game_and_Unit_development#Modeling_.28.3do.2C_~~.s3o~~.29\|3D files~~]] ~~such as .3do~~ or .~~3do~~ to ~~be used by features~~, ~~units or weapons~~.		.3do, [[About_s3o\|.s3o]] or [[Assimp]] compatible 3D model files
	~~Subfolders are allowed~~.		: This contains the actual 3D model that units and features use in-game. Most units have a variety of different pieces that are put together in a hierarchy type form (for instance, a tank has a hull, a turret attached to that, and a barrel attached to that). The {{xtaglink\|Gamedev:UnitDefs\|model}} tag determines what model is used.

	=='''<code>scripts\</code>'''<br>==		=='''<code>scripts\</code>'''<br>==
	[[~~Game_and_Unit_development#Unit_Scripting~~.~~2FAnimations_.28~~.cob~~.2C_.bos.2C_.lua.29\|animation scripts~~]] for units		[[Animation-LuaScripting\|.lua]] or [[Animation-CobOverview\|.cob ]] animation script files
			: This contains all of the animation scripting for the units. Scripts work by calling on pieces of the unit's model to do things, such as rotate a turret to aim at a target, or emit smoke when the unit is damaged. The pieces named in the script file must reflect actual parts of the unit's.

	=='''<code>sidepics\</code>'''<br>==		=='''<code>sidepics\</code>'''<br>==
Line 63:		Line 64:

	=='''<code>units\</code>'''<br>==		=='''<code>units\</code>'''<br>==
	.lua ~~files~~ [[Gamedev:UnitDefs\|~~that define the units.~~]]		.lua [[Gamedev:UnitDefs\|UnitDef]] files
	Subfolders are allowed.		: Contains most of the active data that a unit uses, such as its health, a list of which weapons it has, speed, metal/energy cost, whether it is a construction unit or not, so on and so forth. Subfolders are allowed.

	=='''<code>unitpics\</code>'''<br>==		=='''<code>unitpics\</code>'''<br>==
	[[Gamedev:Buildpics\|~~unit preview~~ pictures ~~for buildmenu~~]]		.dds or .png [[Gamedev:Buildpics\|buildmenu pictures]]
			:Unit pictures are those little thumbnails which show up in the build menus of units in-game. They're just a little graphical representation of the unit so people know what they're building when they click it. Assigned via the {{xtaglink\|Gamedev:UnitDefs\|buildpic}} tag.

	=='''<code>unittextures\</code>'''<br>==		=='''<code>unittextures\</code>'''<br>==
	~~[[Game_and_Unit_development#Modeling_~~.28.~~3do~~.~~2C_.s3o.29~~\|~~Textures for the 3D files~~]] ~~Textures for~~ the ~~3D models~~.		.dds, .tga or .png image [[Units:Textures\|texture]] files.
	Subfolders are allowed.		: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.

	=='''<code>weapons\</code>'''<br>==		=='''<code>weapons\</code>'''<br>==
	~~files that~~ [[Gamedev:WeaponDefs\|~~define~~ weapons]]		.lua [[Gamedev:WeaponDefs\|WeaponDef]] files
	Subfolders are allowed.		: Most units have weapons. The characteristics of these weapons, from its behaviour to how it acts in the air, is determined in the weapon file. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files. Subfolders are allowed.

	[[Category:Game Dev]]		[[Category:Game Dev]]

Flozi: /* unitpics\ */ update link

2013-10-29T11:04:21Z

unitpics\: update link

← Older revision		Revision as of 12:04, 29 October 2013
Line 67:		Line 67:

	=='''<code>unitpics\</code>'''<br>==		=='''<code>unitpics\</code>'''<br>==
	[[~~Units~~:Buildpics\|unit preview pictures for buildmenu]]		[[Gamedev:Buildpics\|unit preview pictures for buildmenu]]

	=='''<code>unittextures\</code>'''<br>==		=='''<code>unittextures\</code>'''<br>==

Flozi: update links

2013-10-28T22:48:08Z

update links

← Older revision		Revision as of 23:48, 28 October 2013
Line 26:		Line 26:

	==='''<code>bitmaps\tracks</code>'''<br>===		==='''<code>bitmaps\tracks</code>'''<br>===
	images that are used for the [[~~Units-~~UnitDefs#Decals\|unit tracks]]		images that are used for the [[Gamedev:UnitDefs#Decals\|unit tracks]]

	=='''<code>features\</code>'''<br>==		=='''<code>features\</code>'''<br>==
	.lua ~~or .fbi~~ files [[~~Units-UnitDefs~~\|that define features (wreckage and such)]]		.lua files [[Gamedev:FeatureDefs\|that define features (wreckage and such)]]
	Subfolders are allowed.		Subfolders are allowed.

Line 39:		Line 39:

	=='''<code>LuaRules\</code>'''<br>==		=='''<code>LuaRules\</code>'''<br>==
	various files to make Lua scripts work such as gadget handler ~~(?)~~		various files to make Lua scripts work such as gadget handler
	==='''<code>LuaRules\Gadgets</code>'''<br>===		==='''<code>LuaRules\Gadgets</code>'''<br>===
	[[Lua_Scripting\|Lua gadgets]]: scripts that ~~controll~~ the gameplay		[[Lua_Scripting\|Lua gadgets]]: scripts that control the gameplay
	==='''<code>LuaRules\Configs</code>'''<br>===		==='''<code>LuaRules\Configs</code>'''<br>===
	config files read by Lua gadgets		config files read by Lua gadgets
Line 63:		Line 63:

	=='''<code>units\</code>'''<br>==		=='''<code>units\</code>'''<br>==
	.lua ~~or .fbi~~ files [[~~Units-~~UnitDefs\|that define the units.]]		.lua files [[Gamedev:UnitDefs\|that define the units.]]
	Subfolders are allowed.		Subfolders are allowed.

Line 74:		Line 74:

	=='''<code>weapons\</code>'''<br>==		=='''<code>weapons\</code>'''<br>==
	files that [[~~Weapon_Variables~~\|define weapons]]		files that [[Gamedev:WeaponDefs\|define weapons]]
	Subfolders are allowed.		Subfolders are allowed.

	[[Category:Game Dev]]		[[Category:Game Dev]]

Flozi: merge in 'Mod file structure' (badly)

2013-10-26T22:22:47Z

merge in 'Mod file structure' (badly)

@@ Line 1: / Line 1: @@
-These are the files to be found in a Spring game.
+= What's an sd7/sdz file? =
-='''<code>root of game folder</code>'''=
+A mod is presented as an [[sd7]] or sdz file.  This is just a zip file of the individual files comprising the game.
 [[Modinfo.lua]] and can also contain [[Modoptions.lua]] and [[AI:Development:Lang:Lua|LuaAI.lua]]

Flozi: Flozi moved page Game structure to Gamedev:Structure

2013-10-26T22:03:35Z

Flozi moved page Game structure to Gamedev:Structure

← Older revision	Revision as of 23:03, 26 October 2013
(No difference)

Flozi: /* bitmaps\loadpictures */

2013-10-26T22:00:58Z

bitmaps\loadpictures

← Older revision		Revision as of 23:00, 26 October 2013
Line 10:		Line 10:
	=='''<code>bitmaps\</code>'''<br>==		=='''<code>bitmaps\</code>'''<br>==

	=='''<code>bitmaps\loadpictures</code>'''<br>==		==='''<code>bitmaps\loadpictures</code>'''<br>===
	pictures that will be displayed when the game loads.		pictures that will be displayed when the game loads.

Flozi: alphabetise

2013-10-26T21:58:52Z

alphabetise

← Older revision		Revision as of 22:58, 26 October 2013
Line 1:		Line 1:
	~~This~~ are the files to be found in a Spring game~~. Optional files or folders such as "config\" folders for ie Lua scripts are not listed~~.		These are the files to be found in a Spring game.

	'''~~This page is unfinished~~'''		='''<code>root of game folder</code>'''=
	~~----~~

	~~='''<code>root of game folder</code>'''<br>=~~
	[[Modinfo.lua]] and can also contain [[Modoptions.lua]] and [[AI:Development:Lang:Lua\|LuaAI.lua]]		[[Modinfo.lua]] and can also contain [[Modoptions.lua]] and [[AI:Development:Lang:Lua\|LuaAI.lua]]

			=='''<code>anims\</code>'''<br>==
			image files for [[MouseCursors\|mouse cursors]]

	=='''<code>bitmaps\</code>'''<br>==		=='''<code>bitmaps\</code>'''<br>==
Line 14:		Line 15:
	==='''<code>bitmaps\tracks</code>'''<br>===		==='''<code>bitmaps\tracks</code>'''<br>===
	images that are used for the [[Units-UnitDefs#Decals\|unit tracks]]		images that are used for the [[Units-UnitDefs#Decals\|unit tracks]]

	~~=='''<code>units\</code>'''<br>==~~
	~~.lua or .fbi files [[Units-UnitDefs\|that define the units.]]~~
	~~Subfolders are allowed.~~

	=='''<code>features\</code>'''<br>==		=='''<code>features\</code>'''<br>==
Line 42:		Line 39:
	=='''<code>objects3d\</code>'''<br>==		=='''<code>objects3d\</code>'''<br>==
	[[Game_and_Unit_development#Modeling_.28.3do.2C_.s3o.29\|3D files]] such as .3do or .3do to be used by features, units or weapons.		[[Game_and_Unit_development#Modeling_.28.3do.2C_.s3o.29\|3D files]] such as .3do or .3do to be used by features, units or weapons.
	~~Subfolders are allowed.~~

	~~=='''<code>unittextures\</code>'''<br>==~~
	~~[[Game_and_Unit_development#Modeling_.28.3do.2C_.s3o.29\|Textures for the 3D files]] Textures for the 3D models.~~
	Subfolders are allowed.		Subfolders are allowed.

Line 56:		Line 49:
	=='''<code>sounds\</code>'''<br>==		=='''<code>sounds\</code>'''<br>==
	[[Sounds.lua\|sound files]]		[[Sounds.lua\|sound files]]

			=='''<code>units\</code>'''<br>==
			.lua or .fbi files [[Units-UnitDefs\|that define the units.]]
			Subfolders are allowed.

	=='''<code>unitpics\</code>'''<br>==		=='''<code>unitpics\</code>'''<br>==
	[[Units:Buildpics\|unit preview pictures for buildmenu]]		[[Units:Buildpics\|unit preview pictures for buildmenu]]

			=='''<code>unittextures\</code>'''<br>==
			[[Game_and_Unit_development#Modeling_.28.3do.2C_.s3o.29\|Textures for the 3D files]] Textures for the 3D models.
			Subfolders are allowed.

	=='''<code>weapons\</code>'''<br>==		=='''<code>weapons\</code>'''<br>==
	files that [[Weapon_Variables\|define weapons]]		files that [[Weapon_Variables\|define weapons]]
	Subfolders are allowed.		Subfolders are allowed.


	~~=='''<code>anims\</code>'''<br>==~~
	~~image files for [[MouseCursors\|mouse cursors]]~~

	[[Category:Game Dev]]		[[Category:Game Dev]]

← Older revision		Revision as of 19:02, 29 October 2013
Line 1:		Line 1:
	= ~~What's an~~ sd7/sdz ~~file?~~ =		= Game Structure =
			== .sd7 or .sdz ==

	A mod is presented as an [[sd7]] or sdz file. This is just a zip file of the individual files comprising the game.		A mod is presented as an [[sd7]] or sdz file. This is just a zip file of the individual files comprising the game.
Line 7:		Line 8:
	sd7 / sdz files are created using 7zip.		sd7 / sdz files are created using 7zip.

	= .sdd directories =		== .sdd directories ==
	You can avoid using the archives altogether by storing the whole mod directory structure in an .sdd directory. This is useful for game development because the changes you make are visible without any additional step.		You can avoid using the archives altogether by storing the whole mod directory structure in an .sdd directory. This is useful for game development because the changes you make are visible without any additional step.

Line 13:		Line 14:
	ln -s ~/projects/caspring/games/zk ~/.spring/games/zk.sdd		ln -s ~/projects/caspring/games/zk ~/.spring/games/zk.sdd

	=='''<code>root of game folder</code>'''==		== Directory Structure ==
			==='''<code>root of game folder</code>'''===

	[[Modinfo.lua]] and can also contain [[Modoptions.lua]] and [[AI:Development:Lang:Lua\|LuaAI.lua]]		[[Modinfo.lua]] and can also contain [[Modoptions.lua]] and [[AI:Development:Lang:Lua\|LuaAI.lua]]

	=='''<code>anims\</code>'''<br>==		==='''<code>anims\</code>'''<br>===
	image files for [[MouseCursors\|mouse cursors]]		image files for [[MouseCursors\|mouse cursors]]

	=='''<code>bitmaps\</code>'''<br>==		==='''<code>bitmaps\</code>'''<br>===

	==='''<code>bitmaps\loadpictures</code>'''<br>===		===='''<code>bitmaps\loadpictures</code>'''<br>====
	pictures that will be displayed when the game loads.		pictures that will be displayed when the game loads.

	==='''<code>bitmaps\tracks</code>'''<br>===		===='''<code>bitmaps\tracks</code>'''<br>====
	images that are used for the [[Gamedev:UnitDefs#Decals\|unit tracks]]		images that are used for the [[Gamedev:UnitDefs#Decals\|unit tracks]]

	=='''<code>features\</code>'''<br>==		==='''<code>features\</code>'''<br>===
	.lua [[Gamedev:FeatureDefs\|FeatureDef]] files		.lua [[Gamedev:FeatureDefs\|FeatureDef]] files
	: Corpse and map-static feature definitions. The corpse files are similar to [[Gamedev:UnitDefs\|UnitDefs]] but usually contain a less data, such as what model to use as the wreckage, how much metal the wreck will give if reclaimed, etc. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files.Subfolders are allowed.		: Corpse and map-static feature definitions. The corpse files are similar to [[Gamedev:UnitDefs\|UnitDefs]] but usually contain a less data, such as what model to use as the wreckage, how much metal the wreck will give if reclaimed, etc. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files.Subfolders are allowed.

	=='''<code>gamedata\</code>'''<br>==		==='''<code>gamedata\</code>'''<br>===
	[[:Category:Gamedata\|Various files]] that control global things or setup graphic & sound resources.		[[:Category:Gamedata\|Various files]] that control global things or setup graphic & sound resources.

	=='''<code>icons\</code>'''<br>==		==='''<code>icons\</code>'''<br>===
	images for [[Icontypes.lua\|unit symbols and radar icons]]		images for [[Icontypes.lua\|unit symbols and radar icons]]

	=='''<code>LuaRules\</code>'''<br>==		==='''<code>LuaRules\</code>'''<br>===
	various files to make Lua scripts work such as gadget handler		various files to make Lua scripts work such as gadget handler
	==='''<code>LuaRules\Gadgets</code>'''<br>===		===='''<code>LuaRules\Gadgets</code>'''<br>====
	[[Lua_Scripting\|Lua gadgets]]: scripts that control the gameplay		[[Lua_Scripting\|Lua gadgets]]: scripts that control the gameplay
	==='''<code>LuaRules\Configs</code>'''<br>===		===='''<code>LuaRules\Configs</code>'''<br>====
	config files read by Lua gadgets		config files read by Lua gadgets

	=='''<code>LuaUI\</code>'''<br>==		==='''<code>LuaUI\</code>'''<br>===
	==='''<code>LuaUI\widgets</code>'''<br>===		===='''<code>LuaUI\widgets</code>'''<br>====
	[[Lua_Scripting\|Lua widget]]: scripts that make up the user interface or do other unsynced things		[[Lua_Scripting\|Lua widget]]: scripts that make up the user interface or do other unsynced things

	=='''<code>objects3d\</code>'''<br>==		==='''<code>objects3d\</code>'''<br>===
	.3do, [[About_s3o\|.s3o]] or [[Assimp]] compatible 3D model files		.3do, [[About_s3o\|.s3o]] or [[Assimp]] compatible 3D model files
	: This contains the actual 3D model that units and features use in-game. Most units have a variety of different pieces that are put together in a hierarchy type form (for instance, a tank has a hull, a turret attached to that, and a barrel attached to that). The {{xtaglink\|Gamedev:UnitDefs\|model}} tag determines what model is used.		: This contains the actual 3D model that units and features use in-game. Most units have a variety of different pieces that are put together in a hierarchy type form (for instance, a tank has a hull, a turret attached to that, and a barrel attached to that). The {{xtaglink\|Gamedev:UnitDefs\|model}} tag determines what model is used.

	=='''<code>scripts\</code>'''<br>==		==='''<code>scripts\</code>'''<br>===
	[[Animation-LuaScripting\|.lua]] or [[Animation-CobOverview\|.cob ]] animation script files		[[Animation-LuaScripting\|.lua]] or [[Animation-CobOverview\|.cob ]] animation script files
	: This contains all of the animation scripting for the units. Scripts work by calling on pieces of the unit's model to do things, such as rotate a turret to aim at a target, or emit smoke when the unit is damaged. The pieces named in the script file must reflect actual parts of the unit's.		: This contains all of the animation scripting for the units. Scripts work by calling on pieces of the unit's model to do things, such as rotate a turret to aim at a target, or emit smoke when the unit is damaged. The pieces named in the script file must reflect actual parts of the unit's.

	=='''<code>sidepics\</code>'''<br>==		==='''<code>sidepics\</code>'''<br>===
	[[Sidedata.lua\|Faction icons]] read by lobby etc.		[[Sidedata.lua\|Faction icons]] read by lobby etc.

	=='''<code>sounds\</code>'''<br>==		==='''<code>sounds\</code>'''<br>===
	[[Sounds.lua\|sound files]]		[[Sounds.lua\|sound files]]

	=='''<code>units\</code>'''<br>==		==='''<code>units\</code>'''<br>===
	.lua [[Gamedev:UnitDefs\|UnitDef]] files		.lua [[Gamedev:UnitDefs\|UnitDef]] files
	: Contains most of the active data that a unit uses, such as its health, a list of which weapons it has, speed, metal/energy cost, whether it is a construction unit or not, so on and so forth. Subfolders are allowed.		: Contains most of the active data that a unit uses, such as its health, a list of which weapons it has, speed, metal/energy cost, whether it is a construction unit or not, so on and so forth. Subfolders are allowed.

	=='''<code>unitpics\</code>'''<br>==		==='''<code>unitpics\</code>'''<br>===
	.dds or .png [[Gamedev:Buildpics\|buildmenu pictures]]		.dds or .png [[Gamedev:Buildpics\|buildmenu pictures]]
	:Unit pictures are those little thumbnails which show up in the build menus of units in-game. They're just a little graphical representation of the unit so people know what they're building when they click it. Assigned via the {{xtaglink\|Gamedev:UnitDefs\|buildpic}} tag.		:Unit pictures are those little thumbnails which show up in the build menus of units in-game. They're just a little graphical representation of the unit so people know what they're building when they click it. Assigned via the {{xtaglink\|Gamedev:UnitDefs\|buildpic}} tag.

	=='''<code>unittextures\</code>'''<br>==		==='''<code>unittextures\</code>'''<br>===
	.dds, .tga or .png image [[Units:Textures\|texture]] files.		.dds, .tga or .png image [[Units:Textures\|texture]] files.
	: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.		: Image files which are stretched over the unit. Texture 1 contains the diffuse and team colour and texture 2 controls reflectivity, specular, glow and 1-bit transparency. Subfolders are allowed.

	=='''<code>weapons\</code>'''<br>==		==='''<code>weapons\</code>'''<br>===
	.lua [[Gamedev:WeaponDefs\|WeaponDef]] files		.lua [[Gamedev:WeaponDefs\|WeaponDef]] files
	: Most units have weapons. The characteristics of these weapons, from its behaviour to how it acts in the air, is determined in the weapon file. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files. Subfolders are allowed.		: Most units have weapons. The characteristics of these weapons, from its behaviour to how it acts in the air, is determined in the weapon file. Some games choose to subsume these into the [[Gamedev:UnitDefs\|UnitDef]] instead of having separate files. Subfolders are allowed.

	[[Category:Game Dev]]		[[Category:Game Dev]]