HowTo:Edit Systems:System Files - Revision history

Tbeholder at 14:12, 9 February 2014

2014-02-09T14:12:00Z

Tbeholder at 13:12, 9 February 2014

2014-02-09T13:12:55Z

Augie.ben.doggie: [vega-bot] [replace] 3 instances of 'http://vegastrike.sourceforge.net/forums' for 'http://forums.vega-strike.org'

2013-01-08T21:29:37Z

[vega-bot] [replace] 3 instances of 'http://vegastrike.sourceforge.net/forums' for 'http://forums.vega-strike.org'

Pyramid: /* Examples */

2011-02-26T22:33:11Z

‎Examples

Nikai: fmt, sp

2010-07-04T08:40:11Z

fmt, sp

pyramid: /* XML schema description */

2008-05-10T23:26:33Z

‎XML schema description

chuck_starchaser at 02:30, 13 December 2007

2007-12-13T02:30:59Z

chuck_starchaser at 02:29, 13 December 2007

2007-12-13T02:29:54Z

Pirx at 18:32, 28 May 2005

2005-05-28T18:32:53Z

141.76.1.121: /* Building a System */ added code tags

2005-04-12T09:25:32Z

‎Building a System: added code tags

@@ Line 10: / Line 10: @@
 * <code>name</code> -- The name of the system.
 * <code>ScaleSystem</code> - The scale of the system.
 {{fixme}}: ScaleSystem is an optional parameter, but this is not indicated. Besides indicating which parameters are optional, versus mandatory; for optional parameters there needs to be information about their default values. (chuck_starchaser)
-* <code>reflectivity</code> - ???
+* <code>reflectivity</code> [float] - ???  Not actually used.
 * <code>background</code> - The background cube map to use (NO extension like .png, .jpg, etc.)
 * <code>nearstars</code> - The number of near stars at a given time.
 * <code>stars</code> - The number of (far?) stars at a given time.
@@ Line 47: / Line 56: @@
 ** <code>day</code> - The amount of time for a day (?)
 ** <code>position</code> - The current position on the orbiting ellipse (in radians).
-** <code><'''citylights''' ... /></code> - Lights that appear on a planet.
+** <code><'''citylights''' ... /></code> - Lights that appear on a planet. The parent object must have planet type.
 *** <code>file</code> - The texture.
 *** <code>alpha</code> - The blend mode of the texture
@@ Line 53: / Line 62: @@
 *** <code>wrapx</code>, <code>wrapy</code> - How much the texture wraps.
 *** <code>insideout</code> - Is the texture inside out? (?)
-** <code><'''atmosphere''' ... /></code> - The clouds of the planet (if any)
+*** <code>VarName</code> [string], <code>VarValue</code> [float] - {{fixme}} seems to be a [[Manual:Config:Advanced:Variables#.22graphics.22_section|graphics/VarName]] confvar based spawn condition (i.e. "add eye-candy only on certain settings").
-*** <code>file</code> - The texture.
+** <code><'''atmosphere''' ... /></code> - The clouds of the planet (if any). The parent object must have planet type.
 *** <code>alpha</code> - The blend mode of the texture
 *** <code>radius</code> - the radius of the atmosphere (should be greater than planet's).
 *** <code>insideout</code> - Is the texture inside out? (?)
 ** <code><'''Terrain''', '''ContinuousTerrain''' ... /></code> - Planet terrains.
 *** <code>NumWraps</code>, <code>ScaleX</code>, <code>ScaleAtmosphereHeight</code> - for Continuous Terrain.
@@ Line 67: / Line 79: @@
 *** <code>ri</code>, <code>rj</code>, <code>rk</code>
 *** <code>qi</code>, <code>qj</code>, <code>qk</code>
-** <code><'''Fog''' ... /></code> - The atmospheric scattering of the planet (if any)
+** <code><'''Fog''' ... /></code> - The atmospheric scattering of the planet (if any). <code>graphics/usePlanetFog</code> must be = true. The parent object must have planet type.
-*** <code>OpticalIllusion</code> [boolean] [=true] - Uses halo system.
+*** <code>OpticalIllusion</code> [boolean] [=true] - Uses halo system instead of making an unit.
 ** <code><'''FogElement''' ... /></code> - Used for stellar atmospheres, in pairs ("atmXatm.bfxm"+"atmXhalo.bfxm"), or even without (in Modelview system - with different alpha), and some test systems.
 *** Red, Green, Blue, Alfa | alpha -- Specify the value (between <code>0</code> and <code>1</code>) of the color. Emission?
@@ Line 77: / Line 89: @@
 *** <code>TailModeStart</code>, <code>TailModeEnd</code>
 *** <code>ScaleAtmosphereHeight</code>
-** <code><'''ring''' ... /></code> - <small>(''repeatable'')</small> A planetary ring.
+** <code><'''ring''' ... /></code> - <small>(''repeatable'')</small> A planetary ring. The parent object must have planet type.
 *** <code>file</code> - The texture.
 *** <code>alpha</code> - The blend mode of the texture
@@ Line 85: / Line 97: @@
 *** <code>si</code>, <code>sj</code>, <code>sk</code> - the nearest point of the orbit (vector x,y,z in meters)
 *** <code>numslices</code> - ???
-** <code><'''SpaceElevator''' ... /></code> - <small>(''repeatable'')</small> An elevator to space (?)
+*** <code>VarName</code> [string], <code>VarValue</code> [float]
 *** <code>file</code> - The file for the elevator.
 *** <code>direction</code> - The direction the elevator goes in. Can be <code>d</code>(own), <code>u</code>(p), <code>l</code>(eft), <code>r</code>(ight), <code>b</code>(ack) or <code>f</code>(ront [default]).
 *** <code>faction</code> - The faction that owns the elevator.
-** <code><'''unit''', '''building''', '''enhancement''', '''vehicle''', '''asteroid''', '''nebula''' ... /></code> - <small>(''repeatable'')</small> An object.
+*** <code>VarName</code> [string], <code>VarValue</code> [float]
 *** NOTE: that these can NOT have anything orbiting them.
 *** <code>name</code> - The name of the unit.
@@ Line 105: / Line 119: @@
 *** <code>day</code> - The amount of time for a day (?)
 *** <code>position</code> - The current position on the orbiting ellipse (in radians).
 ==Building a System==

@@ Line 41: / Line 41: @@
 ** For "suns" that do not orbit:
 *** <code>x</code>, <code>y</code>, <code>z</code> - The position of the planet.
-**For Planets that orbit around another planet:
+** For Planets that orbit around another planet:
 *** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://forums.vega-strike.org/viewtopic.php?p=4391#4391 here])
 *** <code>si</code>, <code>sj</code>, <code>sk</code> - the nearest point of the orbit (vector x,y,z in meters)
@@ Line 57: / Line 57: @@
 *** <code>alpha</code> - The blend mode of the texture
 *** <code>radius</code> - the radius of the atmosphere (should be greater than planet's).
 ** <code><'''Fog''' ... /></code> - The atmospheric scattering of the planet (if any)
 ** <code><'''ring''' ... /></code> - <small>(''repeatable'')</small> A planetary ring.
 *** <code>file</code> - The texture.

@@ Line 42: / Line 42: @@
 *** <code>x</code>, <code>y</code>, <code>z</code> - The position of the planet.
 **For Planets that orbit around another planet:
-*** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=4391#4391 here])
+*** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://forums.vega-strike.org/viewtopic.php?p=4391#4391 here])
 *** <code>si</code>, <code>sj</code>, <code>sk</code> - the nearest point of the orbit (vector x,y,z in meters)
 ** <code>year</code> - The amount of time for a year (?)
@@ Line 63: / Line 63: @@
 *** <code>innerradius</code>, <code>outerradius</code> - the inner/outer radii of the ring (should be greater than planet's and outer should be more than inner).
 *** <code>wrapx</code>, <code>wrapy</code> - How much the texture wraps.
-*** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=4391#4391 here])
+*** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://forums.vega-strike.org/viewtopic.php?p=4391#4391 here])
 *** <code>si</code>, <code>sj</code>, <code>sk</code> - the nearest point of the orbit (vector x,y,z in meters)
 *** <code>numslices</code> - ???
@@ Line 81: / Line 81: @@
 **** <code>x</code>, <code>y</code>, <code>z</code> - The position of the planet.
 *** For units that orbit around another planet:
-**** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=4391#4391 here])
+**** <code>ri</code>, <code>rj</code>, <code>rk</code> - the farthest point of the orbit (vector x,y,z in meters) (see [http://forums.vega-strike.org/viewtopic.php?p=4391#4391 here])
 **** <code>si</code>, <code>sj</code>, <code>sk</code> - the nearest point of the orbit (vector x,y,z in meters)
 *** <code>year</code> - The amount of time for a year (?)

@@ Line 100: / Line 100: @@
 ==Examples==
-* For a simple example, see the '''[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/sectors/enigma_sector/heavens_gate.system?rev=HEAD&content-type=text/vnd.viewcvs-markup Heavens Gate.system]'''
+* For a simple example, see the '''[http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/sectors/Crucible/Cephid_17.system?revision=HEAD&view=markup Cephid_17.system]'''
-* For a more complex system, see '''[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/sectors/Sol/Sol.system?rev=HEAD&content-type=text/vnd.viewcvs-markup Sol.system]'''
+* For a more complex system, see '''[http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/sectors/Sol/Sol.system?revision=HEAD&view=markup Sol.system]'''
 =See also=

@@ Line 10: / Line 10: @@
 * <code>name</code> -- The name of the system.
 * <code>ScaleSystem</code> - The scale of the system.
-FIXME: ScaleSystem is an optional parameter, but this is not indicated. Besides indicating which parameters are optional, versus mandatory; for optional parameters there needs to be information about their default values. (chuck_starchaser)
+{{fixme}}: ScaleSystem is an optional parameter, but this is not indicated. Besides indicating which parameters are optional, versus mandatory; for optional parameters there needs to be information about their default values. (chuck_starchaser)
 * <code>reflectivity</code> - ???
 * <code>background</code> - The background cube map to use (NO extension like .png, .jpg, etc.)
@@ Line 27: / Line 27: @@
 *** red, green, blue, alfa -- Specify the value (between <code>0</code> and <code>1</code>) of the color.
 * <code><'''planet'''> ... </planet></code> - <small>(''repeatable'')</small> (ALIAS: jump) This tag creates a planet (or sun if it generates light).
-** NOTE: planets and jumps can have any (not light) tags nested inside. This creates the nested tag orbiting aroung the planets.
+** NOTE: planets and jumps can have any (not light) tags nested inside. This creates the nested tag orbiting around the planets.
 ** <code>name</code> - The name of the planet.
 ** <code>file</code> - The texture of the planet (also used to decide which products are sold).
@@ Line 36: / Line 36: @@
 ** <code>ReflectNoLight</code> - does the planet not reflect light? Defaults to false, do you shouldn't have to worry about this most of the time.
 ** <code>light</code> - A reference to one of the lights above that this sun generates. This is the criteria for a planet becoming a sun.
-** <code>destinations</code> - A space seperated list of the destinations that this jump point will take you to. (usually only one, but more will make the jump point random). NOTE that the presence of this attribute is the only criteria for the planet being a jump point, not the name of the tag, which is just to make it clearer.
+** <code>destinations</code> - A space separated list of the destinations that this jump point will take you to. (usually only one, but more will make the jump point random). NOTE that the presence of this attribute is the only criteria for the planet being a jump point, not the name of the tag, which is just to make it clearer.
 ** <code>citylights</code> - A texture for using city lights (looks like [Texturefile]wrapx[WrapXValue]wrapy[WrapYValue])
 ** <code>insideout</code> - Is the texture inside out? (?)
@@ Line 46: / Line 46: @@
 ** <code>year</code> - The amount of time for a year (?)
 ** <code>day</code> - The amount of time for a day (?)
-** <code>position</code> - The current position on the orbiting elipse (in radians).
+** <code>position</code> - The current position on the orbiting ellipse (in radians).
 ** <code><'''citylights''' ... /></code> - Lights that appear on a planet.
 *** <code>file</code> - The texture.
@@ Line 75: / Line 75: @@
 *** <code>file</code> - The name of the unit file.
 *** <code>faction</code> - The name of the unit's faction.
-*** <code>destinations</code> - A space seperated list of the destinations that this will take you to. (usually only one, but more will make the jump point random).
+*** <code>destinations</code> - A space separated list of the destinations that this will take you to. (usually only one, but more will make the jump point random).
 *** <code>insideout</code> - Is the texture inside out? (?)
 *** <code>difficulty</code> - A scaling factor???
@@ Line 85: / Line 85: @@
 *** <code>year</code> - The amount of time for a year (?)
 *** <code>day</code> - The amount of time for a day (?)
-*** <code>position</code> - The current position on the orbiting elipse (in radians).
+*** <code>position</code> - The current position on the orbiting ellipse (in radians).
 ==Building a System==
@@ Line 92: / Line 92: @@
 * Next, add X <code><light></code> tags in the system, where X is the number of stars in the system.
 * After that, insert one object inside the system that has <code>x,y,z</code> coordinates. Give it <code>ReflectNoLight="true"</code> and <code>light="some_light_number"</code> to make it be a sun. The sun should have one of the textures inside the <code>stars/</code> directory.
-* Inside that, maybe put another sun orbitting the first sun if the system is binary.
+* Inside that, maybe put another sun orbiting the first sun if the system is binary.
 * Add a bunch of planets, and add units or more planets around those. Planets' textures should be inside the <code>planets</code> directory. You can also have a nebula or an asteroid field if you want.
 * Finally, close with the <code></system></code> tag.

@@ Line 3: / Line 3: @@
 ="Hand-made" System Files=
-These systems take much longer, because you have to do all of the generator's work by hand. Although you may think that using the '''[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/universe/milky_way.xml?rev=HEAD&content-type=text/vnd.viewcvs-markup milky_way.xml]''' file is so much better for that reason, think about systems like Sol (sol_sector/sol) where you want exact exactness to occur in the system file because adventurers who explore it will look at every detail that can not be perfected with even random numbers. I used this method for the starting system in the 3.x releases, enigma_sector/heavens_gate.system
+These systems take much longer, because you have to do all of the generator's work by hand. Although you may think that using the <code>[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/universe/milky_way.xml?rev=HEAD&content-type=text/vnd.viewcvs-markup milky_way.xml]</code> file is so much better for that reason, think about systems like Sol (<code>sol_sector/sol</code>) where you want exact exactness to occur in the system file because adventurers who explore it will look at every detail that can not be perfected with even random numbers. I used this method for the starting system in the 3.x releases, <code>enigma_sector/heavens_gate.system</code>
 ==XML schema description==
@@ Line 104: / Line 104: @@
 * [[HowTo:Edit Systems:Milkyway|Editing systems using Milky_way.XML]]
-[[Category:HowTo|Edit Systems]]
+[[Category:HowTos|Edit Systems]]
 [[Category:Development|Edit Systems]]

@@ Line 87: / Line 87: @@
 ==Building a System==
 To manually create a system, follow these steps;
-* Always put the '''<system>''' tags first.
+* Always put the <code><system></code> tags first.
-* Next, add X lights in the system, where X is the number of stars in the system.
+* Next, add X <code><light></code> tags in the system, where X is the number of stars in the system.
-* After that, insert one object inside the system that has x,y,z coordinates. Give it ReflectNoLight"true" and light "some_light_number" to make it be a sun. The sun should have one of the textures inside the stars/ directory.
+* After that, insert one object inside the system that has <code>x,y,z</code> coordinates. Give it <code>ReflectNoLight="true"</code> and <code>light="some_light_number"</code> to make it be a sun. The sun should have one of the textures inside the <code>stars/</code> directory.
 * Inside that, maybe put another sun orbitting the first sun if the system is binary.
-* Add a bunch of planets, and add units or more planets around those. Planets' textures should be inside the planets directory. You can also have a nebula or an asteroid field if you want.
+* Add a bunch of planets, and add units or more planets around those. Planets' textures should be inside the <code>planets</code> directory. You can also have a nebula or an asteroid field if you want.
-* Finally, close with the '''</system>''' tag.
+* Finally, close with the <code></system></code> tag.
 Note that for a completely circular orbit, make ri=sk, rj=sj and rk=si. <ri,rj,rk> Is the relative position to the planet when position=0. <si,sj,sk> is the relative position to the planet when position=1.57 (PI/2). Then make position 0 (normally) and set day to a fairly high number and year to be extremely high.