Enetheru:smd

From Spring
Revision as of 07:42, 19 July 2010 by Enetheru (talk | contribs)
Jump to navigationJump to search

Spring Map Definition (smd) Reference

General Formatting

  • All lines must end in a ';'
  • Sections begin with a keyword wrapped in Square brackets, and are wrapped in Curly Brackets
  • Blank lines are allowed
  • Comments are preceded by // anything following a comment marker is ignored
  • Whitespace is ignored so you can tabulate your SMD to help the overall readability, and to show where sections begin and end.
// Example (this is a comment)
[MAP]
{
   ...
   // this is a comment
   [subsection]
   {
      ...
      ThisIsAValue = something;
      AnotherValue = somethingelse; // another comment
      ...
   }
   ...
}

Sections

MAP

The map section describes the basic options of the map.

[MAP]
{
   // properties
   Description = "mountainous whatever";
   AutoShowMetal = 1;
   DefaultOptions = 1;
   DetailTex = detailtex.bmp;
   ExtractorRadius = 400;
   Gravity = 130;
   MapHardness = 100;
   MaxMetal = 0.03;
   TidalStrength = 20;
   voidwater = 0;

   // subsections
   [SMF]
   {
      ...
   }
   [ATMOSPHERE]
   {
      ...
   }
   [WATER]
   {
      ...
   }
   [LIGHT]
   {
      ...
   }
   [TEAMx]
   {
      ...
   }
   [TERRAINTYPEx]
   {
      ...
   }
}
Description [string]
Default:FIXME, The description of the map that shows in the multiplayer battleroom.
DefaultOptions [0,1]
Default:FIXME, FIXME
TidalStrength [0-?]
Default:FIXME, The amount of energy which will be given by tidal generators.
Gravity [?-?]
Default:FIXME, The force of gravity in units/sec^2
MaxMetal [0-?]
Default:FIXME, How much metal a map square with the maximum metal value gives.
ExtractorRadius [0-?]
Default:FIXME, The radius of effect that a single extractor will extract from. If two radii intersect, both extractors will suffer from reduced output.
MapHardness [?-?]
Default:FIXME, FIXME
AutoShowMetal [0,1]
Default:FIXME, FIXME
DetailTex [string]
Default:FIXME, FIXME
voidwater [0,1]
Default: 0, FIXME

SMF

[MAP]
{
   ...
   [SMF]
   {
      MinHeight = -100;
      MaxHeight = 100;
   }
   ...
}
MinHeight [-?-?]
Default:FIXME, FIXME
MaxHeight [-?-?]
Default:FIXME, FIXME


ATMOSPHERE

[MAP]
{
   ...
   [ATMOSPHERE]
   {
      CloudColor = 0.9 0.9 0.9;
      CloudDensity = 0.25;
      FogColor = 0.7 0.7 0.8;
      FogStart = 0.48;
      MaxWind = 25;
      MinWind = 1;
      SkyBox = nebulus.dds;
      SkyColor = 0.1 0.15 0.7;
      SunColor = 1.0 1.0 1.0;
   }
   ...
}
CloudColor [0.0-1.0] [0.0-1.0] [0.0-1.0]
Default:FIXME
CloudDensity [0-?]
Default:FIXME
FogColor [0.0-1.0] [0.0-1.0] [0.0-1.0]
Default:FIXME
FogStart [?]
Default:FIXME
MaxWind [0-?]
Default:FIXME
MinWind [0-?]
Default:FIXME
SkyBox [string]
Default:FIXME
SkyColor [0.0-1.0] [0.0-1.0] [0.0-1.0]
Default:FIXME
SunColor [0.0-1.0] [0.0-1.0] [0.0-1.0]
Default:FIXME

LIGHT

[MAP]
{
   ...
   [LIGHT]
   {
      SunDir=2 1 1;
      GroundAmbientColor=0.6 0.6 0.6;
      GroundSunColor=0.9 0.9 0.9;
      GroundShadowDensity=0.6;
      GroundSpecularColor=0 0 0;
      UnitAmbientColor=0.6 0.6 0.6;
      UnitSunColor=0.93 0.93 0.93;
      UnitShadowDensity=0.8;
      UnitSpecularColor=0 0 0;
   }
   ...
}
SunDir
FIXME Should have "default:something, description"
GroundAmbientColor
FIXME Should have "default:something, description"
GroundSunColor
FIXME Should have "default:something, description"
GroundShadowDensity
FIXME Should have "default:something, description"
GroundSpecularColor
FIXME Should have "default:something, description"
UnitAmbientColor
FIXME Should have "default:something, description"
UnitSunColor
FIXME Should have "default:something, description"
UnitShadowDensity
FIXME Should have "default:something, description"
UnitSpecularColor
FIXME Should have "default:something, description"

WATER

[MAP]
{
   ...
   [WATER]
   {
      WaterSurfaceColor=0.3 0.3 0.4;
      WaterBaseColor=0.4 0.6 0.8;
      WaterAbsorb=0.004 0.004 0.002;
      WaterMinColor=0.1 0.1 0.3;
      WaterPlaneColor= 0.1 0.1 0.3;
      WaterDamage=0;

      // Bump Mapped Settings
      WaterSurfaceAlpha = 0.55;
      WaterDiffuseColor = 0.55 0.4 0.3;
      WaterSpecularColor = 0.55 0.4 0.3;
      WaterSpecularPower = 2.0;
      WaterSpecularFactor = 0.3;
      WaterAmbientFactor = 1.3;
      WaterDiffuseFactor = 0.3;
      WaterFresnelMin = 0.3;
      WaterFresnelMax = 0.8;
      WaterFresnelPower = 4;
      WaterReflectionDistortion = 0.1;
      WaterBlurBase = 2;
      WaterBlurExponent = 2;
      WaterPerlinStartFreq = 8;
      WaterPerlinLacunarity = 3;
      WaterPerlinAmplitude= 0.9
   }
   ...
}
WaterSurfaceColor
FIXME Should have "default:something, description"
WaterBaseColor
FIXME Should have "default:something, description"
WaterAbsorb
FIXME Should have "default:something, description"
WaterMinColor
FIXME Should have "default:something, description"
WaterPlaneColor
FIXME Should have "default:something, description"
WaterDamage
FIXME Should have "default:something, description"
WaterSurfaceAlpha
FIXME Should have "default:something, description"
WaterDiffuseColor
FIXME Should have "default:something, description"
WaterSpecularColor
FIXME Should have "default:something, description"
WaterSpecularPower
FIXME Should have "default:something, description"
WaterSpecularFactor
FIXME Should have "default:something, description"
WaterAmbientFactor
FIXME Should have "default:something, description"
WaterDiffuseFactor
FIXME Should have "default:something, description"
WaterFresnelMin
FIXME Should have "default:something, description"
WaterFresnelMax
FIXME Should have "default:something, description"
WaterFresnelPower
FIXME Should have "default:something, description"
WaterReflectionDistortion
FIXME Should have "default:something, description"
WaterBlurBase
FIXME Should have "default:something, description"
WaterBlurExponent
FIXME Should have "default:something, description"
WaterPerlinStartFreq
FIXME Should have "default:something, description"
WaterPerlinLacunarity
FIXME Should have "default:something, description"
WaterPerlinAmplitude
FIXME Should have "default:something, description"

TEAMx

[MAP]
{
   ...
   [TEAM0]
   {
      StartPosX=730;
      StartPosZ=821;
   }
   [TEAM1]
   {
      ...
   }
   [TEAMn]
   {
       ...
   }
   ...
}
StartPosX
FIXME Should have "default:something, description"
StartPosZ
FIXME Should have "default:something, description"

TERRAINTYPEx

[MAP]
{
   ...
   [TERRAINTYPE0]
   {
      name=default;
      hardness=1;
      tankmovespeed=1;
      kbotmovespeed=1;
      hovermovespeed=1;
      shipmovespeed=1;
   }
   [TERRAINTYPE1]
   {
      ...
   }
   [TERRAINTYPEn]
   {
      ...
   }
   ...
}
name
FIXME Should have "default:something, description"
hardness
FIXME Should have "default:something, description"
tankmovespeed
FIXME Should have "default:something, description"
kbotmovespeed
FIXME Should have "default:something, description"
hovermovespeed
FIXME Should have "default:something, description"
shipmovespeed
FIXME Should have "default:something, description"