You are on page 1of 6

The planetary definition data resides in the data/universe/planets.

xml and
the XML files inside the data/universe/planets/ folder.

Each of those files are a simple XML file with <planet> entries. The tag
names are case-sensitive. The files are read in a consistent order:
First data/universe/planets.xml, then the files in data/universe/planets/
subfolder, sorted case-insensitively. Information read later in the process
overwrites information read earlier.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<planets>
<planet>...</planet>
</planets>

Inside the <planet> tag, the following three tags are required:

<name>(string)</name> - the name of the planet
<xcood>(number)</xcood> - X-coordinate on the map, in light years
<ycood>(number)</ycood> - Y-coordinate, also in light years

The remaining information is optional:

<id>(string)</id>

Internal ID of the planet. If not set, equals to the name.
Used to allow multiple planets to share the same name.

If the same ID (or failing that, name) is encountered multiple
times, the later values overwrite the earlier defined values.

<shortName>(string)</shortName>

Short variant of the name, for display purposes.

<sysPos>(integer)</sysPos>

The planet's orbital position in the system.

<spectralType>(string)</spectralType>

The star's spectral type. MekHQ can parse most simple types like
"G2V", "sdM4.5", "O3IIIne", "B5V(e)+DQ6.2" and so on. If set,
the following three values are ignored.

Spectral types starting with "Q" are non-stellar points in space.
In particular, "QB" are black holes, "QN" neutron stars and
"QP" pulsars.

If missing, the spectral type gets generated from the following
values (spectralClass, subtype and luminosity). If those are
also missing, a procedurally generated "habitable" main sequence
dwarf star is set.

<spectralClass>(character)</spectralClass>

One-character description of the spectral class. Valid values
are "O", "B", "A", "F", "G", "K", "M", "L", "T" and "Y"

Ignored if spectral type is set. If only the spectral class is

<orbitInclination>(number between 0. V. <orbitEccentricity>(number at or above 0. VII The luminosity type "VI" are subdwarfs. Ia-0. One of the following values: 0. respectively. Ignored if spectralType is set. in AU. but they are rounded down to the nearest two digits after the decimal dot. II-III. subtype is generated randomly and luminosity is set to "V". IV-V. VI+. I/II.set. else the amount of satellite entries. Defaults to roughly the middle of the habitable zone of the star. IV.0 for calculations.00 and 9. Ignored is spectralType is set. in Earth masses. III-IV. II. . <subtype>(number between 0.0 and below 1. I-II. Iab. "VI+" extreme subdwarfs and "VII" white dwarfs.0 and 90. Defaults to "unknown" for display purposes and 1. defaults to "unknown". Values can be given with any precision. Can be given more than one time if there are more. Both default to "false". VI.0)</orbitInclination> Orbital inclination in relation to the system's invariable plane. Ia. Ib. <orbitRadius>(number)</orbitRadius> Orbital "radius" (technically semimajor axis) of the planet's orbit. II/III.0)</orbitEccentricity> Orbital eccentricity.0 for all calculations requiring it. which is assumed to be at or near 0. IV/V. Defaults to "unknown" if no satellite name is set. <nadirCharge>(true or false)</nadirCharge> <zenithCharge>(true or false)</zenithCharge> If there is a recharging station at the nadir or zenith jump point. Defaults to "unknown". <mass>(number)</mass> Mass of the planet. Also ignored if the luminosity is set to "VII" (white dwarf). <luminosity>(string)</luminosity> A valid luminosity identifier. III. I. Ia+. Ia0. Ib/II. Ib-II.99)</subtype> Numberic sub-type of the spectral class. III/IV. <satellites>(integer)</satellites> Amount of natural satellites of the planet. <satellite>(string)</satellite> Name of a natural satellite of the planet.

0 for calculations. in Earth's gravity. <landMass>(string)</landMass> A continent's of major land mass name. Defaults to "unknown". in Earth masses. Earth's is 2. Can be given more than once. . <dayLength>(number)</dayLength> Length of day (that is not the same as rotational period!) on the planet's equator. Earth has a density of 5515. Valid values correspond to the atmospheric types "vacuum".0 for calculations. <percentWater>(integer between 0 and 100)</percentWater> Amount of the surface area covered by liquid water. Planets with tectonics score of 0 have an unmoving. in hours. Earth's is 2. Defaults to "unknown". Planets with volcanism score of 6 are either just forming or in the process of breaking apart.44. Defaults to "unknown" for display and 0. <density>(number)</density> Density of the planet in kg/m³. Defaults to "unknown" for display purposes and 1. Planets with a tectonics score of 6 have separate "continental" plates the size of small islands. <gravity>(number)</gravity> Surface gravity of the planet. Earth's is 23. <tectonics>(number between 0 and 6)</tectonics> Relative tectonic activity of the planet. <pressure>(integer between 0 and 5)</pressure> The atmosphere's general pressure category. Currently unused. in degrees.0 for calculations. Defaults to "unknown".0)</tilt> Axial tilt of the planet. <tilt>(number between 0. Defaults to "unknown". single crust (but can still have shield volcanoes). <className>(string)</className> Planetary class. "trace".<radius>(number)</radius> Radius of the planet. Defaults to "unknown" for display purposes and 1. <volcanism>(integer between 0 and 6)</volcanism> Amount of volcanic activity on the planet.0 and 90.

This corresponds roughly to how much human population the planet could support even without modern technology (see the "pop" tag for details)."thin". WARM. MICROBE 2. MAMMAL 8. <climate>(string or integer from 0 to 5)</climate> The planet's overall climate. Earth's is 0.0 and 1.0)</albedo> The atmosphere's average albedo (amount of sunlight reflected). "standard". Defaults to "unknown". BOREAL. . Earth's is (currently) 0. REPTILE 6. Alternatively.9645 kg/mol <albedo>(number between 0. Defaults to "unknown" and can be negative. Earth's is 3 (warm-temperate). TEMPERATE. INSECT <habitability>(integer)</habitability> The base habitability of the planet. <atmosphere>(string)</atmosphere> Short description of the atmosphere <atmMass>(number)</atmMass> Atmospheric molar mass compared to Earth's standard 28.12. SUPERTROPICAL. "high" and "very high". BIRD 7. Defaults to "unknown". can be given as one of the following strings: ARCTIC. <greenhouse>(number)</greenhouse> The strength of the planet's greenhouse effect (making it warmer than it should be given its orbital position and albedo). NONE 1. HELL <lifeForm>(string or integer from 0 to 8)</lifeForm> Highest (native) life form (still not killed off by the humans). defaults to "unknown". Defaults to "unknown" for display purposes and 3 (warm-temperate) for calculations. AMPH 5.33. <pressureAtm>(number)</pressureAtm> Air pressure in standard pressure units (101325 Pa). <temperature>(integer above -270)</temperature> The average surface temperature at the equator in °C. FISH 4. TROPICAL. PLANT 3. from 0 (arctic) to 5 (tropical). An integer or string from the following table: 0.

<controlRating>(integer from -1 to 7)</controlRating> The amount of actual control the nominal government wields over the population. 2: free society 3: moderately free society 4: controlled society.Earth's is typically 7. secret police. wild west mentality. <pop>(integer from -1 to 12)</pop> The planet's population rating. <faction>(comma separated list of faction IDs)<faction> The current factions on the planet. as defined in the BT publications. gulags. . with the exception of the clan homeworlds. The valid factions are defined in the . -1 means "no population". Defaults to "unknown". strong weapon control laws and surveillance 5: repressive society. <hpg>(character)</hpg> HPG service rating. Tends to drop sharply towards the periphery. The other values describe orders of magnitude: 0: a few people 1: tens of people 2: hundreds of people 3: thousands 4: tens of thousands 5: hundreds of thousands 6: millions 7: tens of millions 8: hundreds of millions 9: billions 10: tens of billions 11: hundreds of billions 12: trillions Values above 12 make little sense and are displayed as "uncountable" or variant thereof. Default "X". . Earth's pop value is typically 9 or 10. everyone is armed. not even the government bothers pretending otherwise 0: anarchy.. <government>(string)</government> Textual description of the government type. Defaults to X-X-X-X-X. 6: population under total control and surveillance 7: population consists almost entirely of slaves to the ruling class <socioIndustrial>(string)</socioIndustrial> The socio-industrial index as defined in the BT publications.. Defaults to "situation unclear". no governmental control outside of the line of sight of its trooops 1: very free society.. Defaults to "none". The values correspond to textual descriptions as follows: -1: total anarchy..

data/universe/factions.xml file. <event> <date>(date)</date> <message>(string)</message> . The date line is required. The message line is optional and makes the event show up in the daily log. <desc>(string)</desc> Free-form description of the planet and star system. .. if found. Defaults to "false" (obviously). which are used to identify the entry to delete. It's retained for backwards compatibility only and should not be used in newer data sets. </event> A generic event changing some of the planet's data on the given date.. save for name and id. Defaults to "no faction". only applicable to faction changes. <delete>(true or false)</delete> A marker telling the planet data loader to delete the planet with the given ID from its database. as a news item. All the other data defined in the entry is ignored. The following data can be changed: * name * shortName * nadirCharge and zenithCharge * percentWater * pressure * pressureAtm * atmosphere * atmMass * albedo * greenhouse * temperature * climate * lifeForm * habitability * pop * government * controlRating * socioIndustrial * hpg * faction <factionChange> <date>(date)</date> <faction>(comma separated list of faction IDs)</faction> </factionChange> Obsolete form of the event tag.