Resources.lua - Revision history

Gajop at 10:25, 2 December 2018

2018-12-02T10:25:50Z

← Older revision		Revision as of 11:25, 2 December 2018
Line 31:		Line 31:
	The following example (which is becoming a [http://en.wikipedia.org/wiki/De_facto_standard de facto standard]) sets out the engine default textures, and recursively adds any textures from the game's <code>Bitmaps/projectileTextures/</code> and <code>Bitmaps/groundFX/</code> directories, respectively. It will ignore any directories created by [http://en.wikipedia.org/wiki/Apache_Subversion SVN], and can be easily edited to filter out [http://en.wikipedia.org/wiki/Git_(software) git] or any other version control software.		The following example (which is becoming a [http://en.wikipedia.org/wiki/De_facto_standard de facto standard]) sets out the engine default textures, and recursively adds any textures from the game's <code>Bitmaps/projectileTextures/</code> and <code>Bitmaps/groundFX/</code> directories, respectively. It will ignore any directories created by [http://en.wikipedia.org/wiki/Apache_Subversion SVN], and can be easily edited to filter out [http://en.wikipedia.org/wiki/Git_(software) git] or any other version control software.

	~~<code>~~<pre>		<pre>
	local resources = {		local resources = {
	graphics = {		graphics = {
Line 98:		Line 98:
	return resources		return resources

	</pre~~></code~~>		</pre>
	===External===		===External===
	{{sourcelink\|file=cont/base/springcontent/gamedata/resources.lua}} - Engine base content <code>resources.lua</code>		{{sourcelink\|file=cont/base/springcontent/gamedata/resources.lua}} - Engine base content <code>resources.lua</code>

	[[Category:Gamedata]]		[[Category:Gamedata]]

Flozi: 1cat

2013-03-21T09:02:17Z

1cat

← Older revision		Revision as of 10:02, 21 March 2013
Line 102:		Line 102:
	{{sourcelink\|file=cont/base/springcontent/gamedata/resources.lua}} - Engine base content <code>resources.lua</code>		{{sourcelink\|file=cont/base/springcontent/gamedata/resources.lua}} - Engine base content <code>resources.lua</code>

	~~[[Category:Game development]]~~
	[[Category:Gamedata]]		[[Category:Gamedata]]

Flozi: /* Source */ reformat

2013-03-01T23:04:47Z

Source: reformat

← Older revision		Revision as of 00:04, 2 March 2013
Line 7:		Line 7:

	==Source==		==Source==
	The engine source code which parses the data from this file is viewable here:~~{{sourcelink\|file=rts/Rendering/ProjectileDrawer.cpp}} (smoke, groundfx & projectiletextures) <code>resources_map.lua</code> is only read here.~~		The engine source code which parses the data from this file is viewable here:

	{{sourcelink\|file=rts/Rendering/GroundDecalHandler.cpp}} (scars)		* {{sourcelink\|file=rts/Rendering/ProjectileDrawer.cpp}} (smoke, groundfx & projectiletextures) <code>resources_map.lua</code> is only read here.
	{{sourcelink\|file=rts/Rendering/Env/AdvTreeGenerator.cpp}} (trees)
	{{sourcelink\|file=rts/Map/MapInfo.cpp}} (caustics & maps)		* {{sourcelink\|file=rts/Rendering/GroundDecalHandler.cpp}} (scars)
			* {{sourcelink\|file=rts/Rendering/Env/AdvTreeGenerator.cpp}} (trees)
			* {{sourcelink\|file=rts/Map/MapInfo.cpp}} (caustics & maps)

	==Details==		==Details==

Flozi: /* Purpose */ No need to document old behaviour imo?

2012-03-31T17:33:14Z

Purpose: No need to document old behaviour imo?

← Older revision		Revision as of 18:33, 31 March 2012
Line 4:		Line 4:

	==Purpose==		==Purpose==
	This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which~~...~~		This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in the same way.

	~~'''pre 84.0:'''<br>~~
	behaves in ~~a similar~~ way ~~with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> (and as of Spring 0.83.x, <code>groundFX</code>) are read.~~

	~~'''> 84.0:'''<br>~~
	~~[http://springrts.com/phpbb/viewtopic.php?f=13&t=27236 now also uses] the '<code>graphics</code>' sub-table~~.

	==Source==		==Source==

Knorke: /* Purpose */

2011-12-02T17:58:36Z

Purpose

← Older revision		Revision as of 18:58, 2 December 2011
Line 4:		Line 4:

	==Purpose==		==Purpose==
	This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in a similar way with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> (and as of Spring 0.83.x, <code>groundFX</code>) are read.		This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which...

			'''pre 84.0:'''<br>
			behaves in a similar way with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> (and as of Spring 0.83.x, <code>groundFX</code>) are read.

			'''> 84.0:'''<br>
			[http://springrts.com/phpbb/viewtopic.php?f=13&t=27236 now also uses] the '<code>graphics</code>' sub-table.

	==Source==		==Source==

Flozi: address #2632 resolution

2011-09-05T17:48:39Z

address #2632 resolution

← Older revision		Revision as of 18:48, 5 September 2011
Line 4:		Line 4:

	==Purpose==		==Purpose==
	This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in a similar way with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> are read.		This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in a similar way with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> (and as of Spring 0.83.x, <code>groundFX</code>) are read.

	==Source==		==Source==
Line 22:		Line 22:
	* <code>trees</code> - Textures for engine default trees.<br>		* <code>trees</code> - Textures for engine default trees.<br>
	* <code>maps</code> - Base textures in case a map does not provide it's own.<br>		* <code>maps</code> - Base textures in case a map does not provide it's own.<br>
	* <code>groundfx</code> - Game specific textures for [[CEG-Classes#CSimpleGroundFlash\|CSimpleGroundFlash]] CEG's as well as engine default explosion [[CEG-Format#groundflash\|groundflash]].<br>		* <code>groundfx</code> - Game or Map specific textures for [[CEG-Classes#CSimpleGroundFlash\|CSimpleGroundFlash]] CEG's as well as engine default explosion [[CEG-Format#groundflash\|groundflash]].<br>
	* <code>projectiletextures</code> - Game or Map specific textures for the other [[CEG-Classes]] as well as engine defaults. This is the only table that is read from <code>resources_map.lua</code><br>		* <code>projectiletextures</code> - Game or Map specific textures for the other [[CEG-Classes]] as well as engine defaults. This is the only table that is read from <code>resources_map.lua</code><br>

Flozi: try and cleanup the mess I made wrt resources_map

2011-09-01T17:03:09Z

try and cleanup the mess I made wrt resources_map

← Older revision		Revision as of 18:03, 1 September 2011
Line 4:		Line 4:

	==Purpose==		==Purpose==
	This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in ~~the same~~ way with the exception that the intermediary '<code>graphics</code>' sub-table is not used.		This file is used by a game to reference textures for use in [[CEG\|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in a similar way with the exception that the intermediary '<code>graphics</code>' sub-table is not used, and only <code>projectileTextures</code> are read.

	==Source==		==Source==
	The engine source code which parses the data from this file is viewable here:{{sourcelink\|file=rts/Rendering/ProjectileDrawer.cpp}} (smoke, groundfx & projectiletextures)		The engine source code which parses the data from this file is viewable here:{{sourcelink\|file=rts/Rendering/ProjectileDrawer.cpp}} (smoke, groundfx & projectiletextures) <code>resources_map.lua</code> is only read here.

	{{sourcelink\|file=rts/Rendering/GroundDecalHandler.cpp}} (scars)		{{sourcelink\|file=rts/Rendering/GroundDecalHandler.cpp}} (scars)
Line 15:		Line 15:
	==Details==		==Details==

	The engine loads textures from seven subtables within the <code>graphics</code> subtable of the returned resources table ~~(or within the returned table in the case of <code>resources_map.lua</code>)~~. Certain tables are automatically added by the engine if a game is not overriding them, they are numerical arrays whereas all others are key-value associative arrays. Engine defaults which are required to be present are included in the [[#Automatic]] example below.		The engine loads textures from seven subtables within the <code>graphics</code> subtable of the returned resources table. Certain tables are automatically added by the engine if a game is not overriding them, they are numerical arrays whereas all others are key-value associative arrays. Engine defaults which are required to be present are included in the [[#Automatic]] example below.

	* <code>caustics</code> - Textures used with bumpmapped water. Automatically added by the engine.<br>		* <code>caustics</code> - Textures used with bumpmapped water. Automatically added by the engine.<br>
Line 23:		Line 23:
	* <code>maps</code> - Base textures in case a map does not provide it's own.<br>		* <code>maps</code> - Base textures in case a map does not provide it's own.<br>
	* <code>groundfx</code> - Game specific textures for [[CEG-Classes#CSimpleGroundFlash\|CSimpleGroundFlash]] CEG's as well as engine default explosion [[CEG-Format#groundflash\|groundflash]].<br>		* <code>groundfx</code> - Game specific textures for [[CEG-Classes#CSimpleGroundFlash\|CSimpleGroundFlash]] CEG's as well as engine default explosion [[CEG-Format#groundflash\|groundflash]].<br>
	* <code>projectiletextures</code> - Game specific textures for the other [[CEG-Classes]] as well as engine defaults.<br>		* <code>projectiletextures</code> - Game or Map specific textures for the other [[CEG-Classes]] as well as engine defaults. This is the only table that is read from <code>resources_map.lua</code><br>

	==Example==		==Example==

Flozi: /* Location */ line break

2011-09-01T16:58:48Z

Location: line break

← Older revision		Revision as of 17:58, 1 September 2011
Line 1:		Line 1:
	==Location==		==Location==
	<code>resources.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.		<code>resources.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.<br>
	<code>resources_map.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Map.		<code>resources_map.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Map.

Flozi: /* Location */ mention resources_map here

2011-09-01T16:58:32Z

Location: mention resources_map here

← Older revision		Revision as of 17:58, 1 September 2011
Line 1:		Line 1:
	==Location==		==Location==
	<code>resources.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.		<code>resources.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.
			<code>resources_map.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Map.

	==Purpose==		==Purpose==

Flozi: resources.lua page - could maybe do with more explanation of what the engine default entries are used for but this is better than nothing!

2011-09-01T16:57:45Z

resources.lua page - could maybe do with more explanation of what the engine default entries are used for but this is better than nothing!

New page

==Location==
<code>resources.lua</code> is a file in the <code>Gamedata/</code> directory of a Spring Game.

==Purpose==
This file is used by a game to reference textures for use in [[CEG|Custom Explosion Generators]], as well as various default explosions and other engine textures such as default trees and water etc. Maps have a corresponding file, <code>resources_map.lua</code> which behaves in the same way with the exception that the intermediary '<code>graphics</code>' sub-table is not used.

==Source==
The engine source code which parses the data from this file is viewable here:{{sourcelink|file=rts/Rendering/ProjectileDrawer.cpp}} (smoke, groundfx & projectiletextures)

{{sourcelink|file=rts/Rendering/GroundDecalHandler.cpp}} (scars)
{{sourcelink|file=rts/Rendering/Env/AdvTreeGenerator.cpp}} (trees)
{{sourcelink|file=rts/Map/MapInfo.cpp}} (caustics & maps)

==Details==

The engine loads textures from seven subtables within the <code>graphics</code> subtable of the returned resources table (or within the returned table in the case of <code>resources_map.lua</code>). Certain tables are automatically added by the engine if a game is not overriding them, they are numerical arrays whereas all others are key-value associative arrays. Engine defaults which are required to be present are included in the [[#Automatic]] example below.

* <code>caustics</code> - Textures used with bumpmapped water. Automatically added by the engine. 
* <code>smoke</code> - Textures used for engine default smoke. Automatically added by the engine. 
* <code>scars</code> - Textures used for the burn scars left on the map by weapon explosions. Automatically added by the engine. 
* <code>trees</code> - Textures for engine default trees. 
* <code>maps</code> - Base textures in case a map does not provide it's own. 
* <code>groundfx</code> - Game specific textures for [[CEG-Classes#CSimpleGroundFlash|CSimpleGroundFlash]] CEG's as well as engine default explosion [[CEG-Format#groundflash|groundflash]]. 
* <code>projectiletextures</code> - Game specific textures for the other [[CEG-Classes]] as well as engine defaults. 

==Example==
===Automatic===
The following example (which is becoming a [http://en.wikipedia.org/wiki/De_facto_standard de facto standard]) sets out the engine default textures, and recursively adds any textures from the game's <code>Bitmaps/projectileTextures/</code> and <code>Bitmaps/groundFX/</code> directories, respectively. It will ignore any directories created by [http://en.wikipedia.org/wiki/Apache_Subversion SVN], and can be easily edited to filter out [http://en.wikipedia.org/wiki/Git_(software) git] or any other version control software.

<code><pre>
local resources = {
graphics = {
-- Spring Defaults
trees = {
bark = 'Bark.bmp',
leaf = 'bleaf.bmp',
gran1 = 'gran.bmp',
gran2 = 'gran2.bmp',
birch1 = 'birch1.bmp',
birch2 = 'birch2.bmp',
birch3 = 'birch3.bmp',
},
maps = {
detailtex = 'detailtex2.bmp',
watertex = 'ocean.jpg',
},
groundfx = {
groundflash = 'groundflash.tga',
groundring = 'groundring.tga',
seismic = 'circles.tga',
},
projectiletextures = {
circularthingy = 'circularthingy.tga',
laserend = 'laserend.tga',
laserfalloff = 'laserfalloff.tga',
randdots = 'randdots.tga',
smoketrail = 'smoketrail.tga',
wake = 'wake.tga',
flare = 'flare.tga',
explo = 'explo.tga',
explofade = 'explofade.tga',
heatcloud = 'explo.tga',
flame = 'flame.tga',
muzzleside = 'muzzleside.tga',
muzzlefront = 'muzzlefront.tga',
largebeam = 'largelaserfalloff.tga',
},
}
}

local VFSUtils = VFS.Include('gamedata/VFSUtils.lua')

local function AutoAdd(subDir, map, filter)
local dirList = RecursiveFileSearch("bitmaps/" .. subDir)
for _, fullPath in ipairs(dirList) do
local path, key, ext = fullPath:match("bitmaps/(.*/(.*)%.(.*))")
if not fullPath:match("/%.svn") then
local subTable = resources["graphics"][subDir] or {}
resources["graphics"][subDir] = subTable
if not filter or filter == ext then
if not map then
table.insert(subTable, path)
else -- a mapped subtable
subTable[key] = path
end
end
end
end
end

-- Add mod projectiletextures and groundfx
AutoAdd("projectiletextures", true)
AutoAdd("groundfx", true)

return resources

</pre></code>
===External===
{{sourcelink|file=cont/base/springcontent/gamedata/resources.lua}} - Engine base content <code>resources.lua</code>

[[Category:Game development]]
[[Category:Gamedata]]