Sidedata.lua

From Spring
Revision as of 07:35, 29 March 2011 by Knorke (talk | contribs) (page created)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

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

Shortest working: (some widgets such as advanced playerlist complain about missing faction icon but otherwise works)

local sideData = {
[1] = {
name      = 'AwesomeDudes',
startunit = 'awesomedudebase',
  },
}
return sideData

multiple factions:

local sideData = {
 [1] = {
  name      = 'NKG',
  startunit = 'bflagship2',
 },
 [2] = {
  name      = 'Drone',
  startunit = 'kdroneengineer',
 },
}
return sideData

yea indenting sucks, deal with it.

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