Sidedata.lua: Difference between revisions
From Spring
Jump to navigationJump to search
page created |
|||
| Line 10: | Line 10: | ||
==Example== | ==Example== | ||
Single faction: | |||
( | |||
<pre> | <span class="note">(NB: Some widgets, such as advanced playerlist, may complain about missing faction icon with such a minimal entry)</span> | ||
<code><pre> | |||
local sideData = { | local sideData = { | ||
{ | |||
name | name = 'AwesomeDudes', | ||
startunit = 'awesomedudebase', | startunit = 'awesomedudebase', | ||
}, | |||
} | } | ||
return sideData | return sideData | ||
</pre> | </pre></code> | ||
Multiple factions: | |||
<pre> | <code><pre> | ||
local sideData = { | local sideData = { | ||
{ | |||
name = 'NKG', | |||
startunit = 'bflagship2', | |||
}, | |||
{ | |||
name = 'Drone', | |||
startunit = 'kdroneengineer', | |||
}, | |||
} | } | ||
return sideData | return sideData | ||
</pre> | </pre></code> | ||
==Faction Icons== | ==Faction Icons== | ||
Revision as of 12:45, 2 April 2011
What and & Where is it?
sitedata.lua is a file in the gamedata\ folder of a Spring Game. It defines the playable factions/races/sides in a game. (ie ARM & CORE, Terran, Protoss, USA, Bananas,...)
Details
A faction can have several properties, commonly used are:
-a name (displayed in lobby)
-a startunit (must be read by a gadget to actually spawn the start unit)
-an icon (displayed in lobby)
Example
Single faction:
(NB: Some widgets, such as advanced playerlist, may complain about missing faction icon with such a minimal entry)
local sideData = {
{
name = 'AwesomeDudes',
startunit = 'awesomedudebase',
},
}
return sideData
Multiple factions:
local sideData = {
{
name = 'NKG',
startunit = 'bflagship2',
},
{
name = 'Drone',
startunit = 'kdroneengineer',
},
}
return sideData
Faction Icons
It seems they are not defined in this file but just read from a folder sidepics\
Can be .bmp and maybe other formats. Filename is same as Faction name ie for above examples: AwesomeDudes.bmp NKG.bmp Drone.bmp
