Difference between revisions of "Stars.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(→‎Stars)
m (update)
Line 1: Line 1:
 +
Revision information.. <!-- Please update this information when page is updated -->
 +
::'''3.6.x branch:''' 2.72.2.20
 +
::'''3.7 branch:''' 2.97
 +
 +
 
Stars.tbl is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.
 
Stars.tbl is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.
 +
  
 
==General Format==
 
==General Format==
Line 14: Line 20:
 
*<nowiki>#</nowiki>'''End'''
 
*<nowiki>#</nowiki>'''End'''
 
**Must be included to the end of the stars.tbl
 
**Must be included to the end of the stars.tbl
 +
  
 
===Background graphics===
 
===Background graphics===
Line 19: Line 26:
 
*Background graphics can be defined in to different forms:
 
*Background graphics can be defined in to different forms:
 
**'''$Bitmap:'''
 
**'''$Bitmap:'''
−
***This entry type is used for transparent objects such as background nebulas
+
***This entry type is used for alpha blended transparent objects
−
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$BitmapX:'''
 
**'''$BitmapX:'''
−
***This entry type is used for non transparent objects such as planets
+
***This entry type is used for 'green transparency' objects (ie. 0,255,0 is transparent)
−
**Syntax: ''Name''
+
**Syntax: '''String''', filename
 +
 
  
 
===Stars===
 
===Stars===
Line 29: Line 37:
 
**'''$Sun:'''
 
**'''$Sun:'''
 
***Defines the name of the used star
 
***Defines the name of the used star
−
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$SunGlow:'''
 
**'''$SunGlow:'''
 
***Defines the bitmap or animation used as a glow for the star
 
***Defines the bitmap or animation used as a glow for the star
−
***Syntax: ''Name''
+
***Syntax: '''String''', filename
 
**'''$SunRGBI:'''
 
**'''$SunRGBI:'''
 
***Defines the color of the sun as well as it's intensity
 
***Defines the color of the sun as well as it's intensity
−
***Syntax: ''Value Value Value Value'', (red, green, blue and intensity respectively)<font color=red>
+
***Syntax: '''Color''', four '''integers''', 0 to 255, red, green, blue and alpha respectively
−
**'''$SunSpecularRGB:'''
+
 
−
***Defines the color of the sun specuular lighting if it is to be different from '''$SunRGBI:''' values
+
{{Table36|
−
***Syntax: ''Value Value Value'', (red, green and blue respectively)
+
:*'''$SunSpecularRGB:'''
−
**'''$Flare:'''
+
:**Defines the color of the sun specuular lighting if it is to be different from '''$SunRGBI:''' values
−
***Defines lens flare effect.
+
:**Syntax: '''Color''', three '''integers''', 0 to 255, red, green and blue respectively
−
***'''+FlareCount:'''  
+
:*'''$Flare:'''
−
****Defines number of lens flare effects attached yo the sun, if the value is omitted then 1 is used as a default number of flare effects.
+
:**Defines lens flare effect.
−
****Syntax: ''Value''
+
:**'''+FlareCount:'''  
−
***'''$FlareTexture''N'':'''
+
:***Defines number of lens flare effects attached yo the sun, if the value is omitted then 1 is used as a default number of flare effects.
−
****Defines the name of the bitmap used for the particular ( N ) lens flare texture.
+
:***Syntax: '''Integer'''
−
****Syntax: ''Name''
+
:**'''$FlareTexture''N'':'''
−
***For each (defined in '''+FlareCount:''') lens flare effect
+
:***Defines the name of the bitmap used for the particular ( N ) lens flare texture.
−
****'''$FlareGlow''X'':'''
+
:***Syntax: '''String''', filename
−
*****Defines the Xth lens flare effect.
+
:**For each (defined in '''+FlareCount:''') lens flare effect
−
*****'''+FlareTexture:'''
+
:***'''$FlareGlow''X'':'''
−
******Defines the texture used for the lens flare effect.
+
:****Defines the Xth lens flare effect.
−
******Syntax: ''Value'', number of the texture defines in '''$FlareTexture''N'':'''.
+
:****'''+FlareTexture:'''
−
*****'''+FlarePos:'''
+
:*****Defines the texture used for the lens flare effect.
−
******Defines the position of the lens flare effect, relative value
+
:*****Syntax: '''Integer''', number of the texture defines in '''$FlareTexture''N'':'''.
−
******Syntax: ''Value''
+
:****'''+FlarePos:'''
−
*****'''+FlareScale:'''
+
:*****Defines the position of the lens flare effect, relative value
−
******Defines the scaling factor used for the lens flare effect.
+
:*****Syntax: '''Float'''
−
******Syntax: ''Value''
+
:****'''+FlareScale:'''
−
**'''$NoGlare:'''
+
:*****Defines the scaling factor used for the lens flare effect.
−
***Disables blinding in that sun.
+
:*****Syntax: '''Float'''
−
***Syntax: Just put $NoGlare: without any parameters
+
:*'''$NoGlare:'''
−
</font>
+
:**Disables blinding effect from the sun.
 +
:**Usage: '''$NoGlare:''' without any parameters}}
 +
 
  
 
===Non-nebula debris===
 
===Non-nebula debris===
Line 68: Line 78:
 
**'''$Debris:'''
 
**'''$Debris:'''
 
***Defines the animations used for the debris
 
***Defines the animations used for the debris
−
***Syntax: ''Name''
+
***Syntax: '''String'''
 +
 
  
 
===Nebula debris===
 
===Nebula debris===
Line 74: Line 85:
 
**'''$DebrisNeb:'''
 
**'''$DebrisNeb:'''
 
***Defines the animations used for the debris
 
***Defines the animations used for the debris
−
***Syntax: ''Name''
+
***Syntax: '''String'''
 +
 
  
 
==Sample==
 
==Sample==
 +
<pre>
 +
$Bitmap:      dneb01
 +
 +
#end
 +
 +
$Sun:        SunWhite
 +
$Sunglow:    Sunglow01
 +
$SunRGBI:    1.0 1.0 1.0 1.0
 +
 +
#end
 +
 +
$Debris:      debris01
 +
$Debris:      debris02
 +
$Debris:      debris03
 +
$Debris:      debris04
 +
 +
#end
 +
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
$DebrisNeb:  gas
 +
 +
#end
  
−
    $Bitmap:      dneb01
+
#end
−
  #end
+
</pre>
−
    $Sun:        SunWhite
 
−
    $Sunglow:    Sunglow01
 
−
    $SunRGBI:    1.0 1.0 1.0 1.0
 
−
  #end
 
−
    $Debris:      debris01
 
−
    $Debris:      debris02
 
−
    $Debris:      debris03
 
−
    $Debris:      debris04
 
−
  #end
 
−
    $DebrisNeb:  gas
 
−
    $DebrisNeb:  gas
 
−
    $DebrisNeb:  gas
 
−
    $DebrisNeb:  gas
 
−
  #end
 
−
  #end
 
  
  
 
[[Category:Tables]]
 
[[Category:Tables]]

Revision as of 18:55, 30 July 2007

Revision information..

3.6.x branch: 2.72.2.20
3.7 branch: 2.97


Stars.tbl is used to define available background graphics, all the stars or suns that create colored light for the game and used debris animations.


General Format

  • Stars.tbl consist of several sections
  • Between different sections #End must be used
  • Background graphics
    • Defines the available background graphics (nebulas, planets, etc.)
  • Stars
    • Defines the stars
  • Non-nebula debris
    • Defines animation for non-nebula mode
  • Nebula debris
    • Defines animation for nebula mode
  • #End
    • Must be included to the end of the stars.tbl


Background graphics

  • Background graphics use the names of their respective graphic files
  • Background graphics can be defined in to different forms:
    • $Bitmap:
      • This entry type is used for alpha blended transparent objects
      • Syntax: String, filename
    • $BitmapX:
      • This entry type is used for 'green transparency' objects (ie. 0,255,0 is transparent)
    • Syntax: String, filename


Stars

  • Stars are defined with several different parameters.
    • $Sun:
      • Defines the name of the used star
      • Syntax: String, filename
    • $SunGlow:
      • Defines the bitmap or animation used as a glow for the star
      • Syntax: String, filename
    • $SunRGBI:
      • Defines the color of the sun as well as it's intensity
      • Syntax: Color, four integers, 0 to 255, red, green, blue and alpha respectively


FS2 Open, 3.6.x:
  • $SunSpecularRGB:
    • Defines the color of the sun specuular lighting if it is to be different from $SunRGBI: values
    • Syntax: Color, three integers, 0 to 255, red, green and blue respectively
  • $Flare:
    • Defines lens flare effect.
    • +FlareCount:
      • Defines number of lens flare effects attached yo the sun, if the value is omitted then 1 is used as a default number of flare effects.
      • Syntax: Integer
    • $FlareTextureN:
      • Defines the name of the bitmap used for the particular ( N ) lens flare texture.
      • Syntax: String, filename
    • For each (defined in +FlareCount:) lens flare effect
      • $FlareGlowX:
        • Defines the Xth lens flare effect.
        • +FlareTexture:
          • Defines the texture used for the lens flare effect.
          • Syntax: Integer, number of the texture defines in $FlareTextureN:.
        • +FlarePos:
          • Defines the position of the lens flare effect, relative value
          • Syntax: Float
        • +FlareScale:
          • Defines the scaling factor used for the lens flare effect.
          • Syntax: Float
  • $NoGlare:
    • Disables blinding effect from the sun.
    • Usage: $NoGlare: without any parameters


Non-nebula debris

  • There must always be four (4) of these
    • $Debris:
      • Defines the animations used for the debris
      • Syntax: String


Nebula debris

  • There must always be four (4) of these
    • $DebrisNeb:
      • Defines the animations used for the debris
      • Syntax: String


Sample

$Bitmap:      dneb01

#end

$Sun:         SunWhite
$Sunglow:     Sunglow01
$SunRGBI:     1.0 1.0 1.0 1.0

#end

$Debris:      debris01
$Debris:      debris02
$Debris:      debris03
$Debris:      debris04

#end

$DebrisNeb:   gas
$DebrisNeb:   gas
$DebrisNeb:   gas
$DebrisNeb:   gas

#end

#end
Retrieved from "https://wiki.hard-light.net/index.php?title=Stars.tbl&oldid=11049"