You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,22 @@
1
-
This is the official wiki for the [Kopernicus](https://github.com/Kopernicus/Kopernicus) addon for Kerbal Space Program.
1
+
# Kopernicus Wiki
2
+
This is the official wiki for the [Kopernicus](https://github.com/Kopernicus/Kopernicus) addon for Kerbal Space Program.
2
3
The current targeted version of Kopernicus is 1.7.3-1.
3
4
4
-
# Contributing
5
+
##Contributing
5
6
It is preferred that all contributions be done via a text editor and a Git client, as opposed to authoring the changes on GitHub.
6
7
This allows for consistent page formatting. If you wish to be able to test out changes before uploading, you must install Jekyll and its dependencies.
7
8
8
-
## External Programs
9
+
###External Programs
9
10
10
-
### Installing Git
11
+
####Installing Git
11
12
You may use whatever Git GUI/client you wish, although if you do not already have one we recommend GitKraken or Git itself. The latest version of Git can be downloaded from [https://git-scm.com/downloads](https://git-scm.com/downloads) and GitKraken can be found at [https://www.gitkraken.com/download](https://www.gitkraken.com/download)
12
13
13
-
### Installing Jekyll (optional)
14
-
Head to [https://jekyllrb.com/docs/installation/](https://jekyllrb.com/docs/installation/) and scroll to the bottom.
14
+
####Installing Jekyll (optional)
15
+
Head to [https://jekyllrb.com/docs/installation/](https://jekyllrb.com/docs/installation/) and scroll to the bottom.
15
16
Click the link that corresponds to your operating system and follow the directions on that page.
16
17
17
-
## Authoring Changes
18
-
Once you have installed all external programs, fork the wiki repository before cloning your fork to your computer. Create a new branch when making any changes whatsoever. Be sure that your changes follow the stylistic guidelines discussed below.
18
+
###Authoring Changes
19
+
Once you have installed all external programs, fork the wiki repository before cloning your fork to your computer. Create a new branch when making any changes whatsoever. Be sure that your changes follow the stylistic guidelines discussed below.
19
20
20
21
### Page Format
21
22
The format for every page should be as follows:
@@ -30,7 +31,7 @@ Description of the feature/node being discussed, plus an explanation of what it
30
31
**Example**
31
32
```
32
33
// Your example of the item should go here.
33
-
// Comments should be inline like these unless the comment is for a node.
34
+
// Comments should be inline like these unless the comment is for a node.
34
35
// If so, then the comments should go on the line above the node.
35
36
36
37
// ForANode information
@@ -46,8 +47,7 @@ ForANode
46
47
|Property|Format|Description|
47
48
|--------|------|-----------|
48
49
|The name of the property|[type of the property](main/datatypes.md)|The description of the property.|
49
-
|(Example) order|Integer|The order the PQSMod should be applied in.|
50
-
51
-
**Links**
50
+
|(Example) order|Integer|The order the PQSMod should be applied in.|
52
51
52
+
### Links
53
53
Intra-repository links are to be in the form `[text]({{ site.baseurl }}{% link <absolute path in repo> %})`
Copy file name to clipboardexpand all lines: content/ConfigNodes.md
+25-10
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,11 @@ layout: default
3
3
title: Config Nodes
4
4
---
5
5
6
-
# What is a ConfigNode?
6
+
***What is a ConfigNode?***
7
7
ConfigNodes are a data storage / settings format that is used by KSP. They are most commonly used in `.cfg` files, but you can find them inside of `.craft` and `.sfs` files too.
8
8
Whenever you want to modify anything in KSP, you will have to deal with ConfigNodes.
9
9
10
-
A Config Node consists of three parts:
11
-
10
+
A Config Node consists of three parts:
12
11
* header
13
12
* values
14
13
* subnodes
@@ -72,13 +71,13 @@ Kopernicus
72
71
{
73
72
// Naming the system
74
73
name = My cool system
75
-
74
+
76
75
// Creating my first body
77
76
Body
78
77
{
79
78
// I have heard this name before...
80
79
name = Kerbin
81
-
80
+
82
81
// Access the properties of the body
83
82
Properties
84
83
{
@@ -107,21 +106,20 @@ Kopernicus
107
106
{
108
107
// I have heard this name before...
109
108
name = Kerbin
110
-
109
+
111
110
// Access the properties of the body
112
111
Properties
113
112
{
114
113
// Describing Kerbin
115
114
description = That blue ball around the Sun
116
-
115
+
117
116
} // Properties
118
-
117
+
119
118
} // Body
120
119
121
120
} // Kopernicus
122
121
```
123
122
124
-
125
123
That way you can always tell where you actually added the node.
126
124
127
125
# ModuleManager
@@ -232,5 +230,22 @@ Kopernicus
232
230
## Conditions
233
231
All configs that were previously shown would apply themselves to the first node they can find that matches their name. This is undesired in most cases, since you want to be able to finetune the config of a specific body or part etc. ModuleManager can, instead of selecting the first matching one, select configs based on their values. To do this, you have to add `:HAS[#name[value]]` to the name of the node. `name` is the key of the value you want to select, and `value` it's value. If the value doesn't matter to you, you can use a wildcard, that will match everything: `:HAS[#name[*]]`. You can also negate the selection, `:HAS[~name[value]]` will select a config that doesn't have a property with the specified name.
234
232
235
-
**TODO: :NEEDS, :FOR, :AFTER**
233
+
### :NEEDS[]
234
+
The `:NEEDS` condition allows a config to specify its dependencies. The config will not run if the specified mod is not installed. The name of the mod will most commonly be the folder name in GameData. Sometimes, the name of the mod will be the name of the `.dll` file, which can be found by right-clicking the file on Windows and selecting Properties. For nested mods in GameData, the name can be found in the config (the `:FOR` condition discussed later). For example, putting `:NEEDS[Fruits]` after the node name makes the config run *only if* the mod `Fruits` is installed.
235
+
236
+
### :FOR[]
237
+
`:FOR[]` specifies the mod that the config belongs to. It can be used if the mod is located in a nested folder inside GameData. Usually, not every config in a mod will need to include the `:FOR[]` condition.
238
+
239
+
### Mod Order
240
+
Module Manager loads mods in a certain order according to their conditions.
241
+
1.`:FIRST`
242
+
2. Configs with no condition
243
+
3.`:BEFORE[]`
244
+
4.`:FOR[]`
245
+
5.`:AFTER[]`
246
+
6.`:LAST[]`
247
+
7.`:FINAL`
248
+
249
+
Each of the conditions except for `:FINAL` accept a mod to go before/for/after/last. Mod names are discussed in the `:NEEDS[]` section.
Copy file name to clipboardexpand all lines: content/Ocean.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: default
3
3
title: Ocean
4
4
---
5
5
6
-
The `Ocean { }` subnode contains all of the information needed to produce an ocean for the specified body. Note that the ocean is one of two Procedural Quad Spheres on the body it is applied to. This means that some PQS Settings can be applied to Oceans.
6
+
The `Ocean { }` subnode contains all of the information needed to produce an ocean for the specified body. Note that the ocean is one of the two Procedural Quad Spheres on the body it is applied to. This means that some PQS Settings can be applied to Oceans.
Copy file name to clipboardexpand all lines: content/Orbit.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -24,8 +24,8 @@ Orbit
24
24
25
25
|Property|Format|Description|
26
26
|--------|------|-----------|
27
-
|referenceBody|String|The `name` of the object the body orbits.|
28
-
|color|Color|The color of the orbit line. See [the DataTypes page]({{ site.baseurl }}{% link content/datatypes.md %}) for more info on colors.|
27
+
|referenceBody|String|The `name` of the object the body orbits.|
28
+
|color|Color|The color of the orbit line. See [the DataTypes page]({{ site.baseurl }}{% link content/datatypes.md %}) for more info on colors.|
29
29
|inclination|Double|The tilt of the orbit in degrees. 0 = normal, 90 = polar, 180 = retrograde, etc...|
30
30
|eccentricity|Double|The difference between your body's apoapsis and periapsis. It is a value between 0 and 1, where 0 is a perfect circle, and 1 is a straight line. 0.5 would give an oval shape.|
31
31
|period|Double|The custom orbital period in seconds. This can be used to set extreme orbital periods.|
Copy file name to clipboardexpand all lines: content/PQSMods/LandControl/LandClasses.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: default
3
3
title: LandClasses
4
4
---
5
5
6
-
`LandClasses` are regions defined by the LandControl PQSMod, in which several features can be customized including features which other PQSMods provide, such as HeightColorMap or noise PQSMods. LandControl regions can change terrain height, change terrain color, add color noise and height noise, and add ground scatters. LandClasses are defined via ranges of altitude, latitude, and longitude.
6
+
`LandClasses` are regions specified by the LandControl PQSMod that can locally customize several features of the PQS, including features from other PQSMods like HeightColorMap or noise PQSMods. LandClasses can change terrain height, change terrain color, add color noise and height noise, and add ground scatters. LandClasses are defined via ranges of altitude, latitude, and longitude.
7
7
8
8
**Subnodes** - Both are defined under the main table.
9
9
* LerpRange { } = Defines range values
@@ -83,7 +83,7 @@ LandControl
83
83
|name|String|The name of the LandClass.|
84
84
|alterApparentHeight|Single|Supposedly adjusts the terrain's appearance. Only ever observed in the practice of forming icecaps.|
85
85
|alterRealHeight|Double|Supposedly adjusts the terrain's actual height.|
86
-
|minimumRealHeight|Double|The minimum height of the LandClass' terrain.|
86
+
|minimumRealHeight|Double|The minimum height of the LandClass's terrain.|
87
87
|color|Color|The color of the region.|
88
88
|coverageBlend|Single|The blend of the coverage with surrounding LandClasses.|
89
89
|coverageFrequency|Single|The size of the each feature of the LandClass coverage. As frequency gets bigger, size gets smaller.|
Copy file name to clipboardexpand all lines: content/PQSMods/LandControl/LandControlLanding.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,8 @@ title: LandControl
4
4
---
5
5
6
6
The `LandControl` PQSMod allows very detailed control over the coloration of terrain, creation of ground scatters, minimum terrain height, and much more.
7
-
It is both verbose and complex with multiple key parts, so in the interest of ease of use and readability (as well as the sanity of the maintainers) LandControl will be split up into a series of pages.
7
+
8
+
It is both verbose and complex with multiple key parts, so in the interest of ease of use and readability (as well as the sanity of the maintainers), LandControl will be split up into a series of pages.
8
9
9
10
*[LandControl]({{ site.baseurl }}{% link content/PQSMods/LandControl/LandControl.md %})
10
11
*[LandClasses]({{ site.baseurl }}{% link content/PQSMods/LandControl/LandClasses.md %})
Copy file name to clipboardexpand all lines: content/PQSMods/LandControl/Scatters.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: default
3
3
title: Scatters
4
4
---
5
5
6
-
The `Scatters` node in the LandControl PQSMod defines the scatters to be used within the [LandClasses]({{ site.baseurl }}{% link content/PQSMods/LandControl/LandClasses.md %}) provided by LandControl.
6
+
The `Scatters` node in the LandControl PQSMod defines the scatters to be used within the [LandClasses]({{ site.baseurl }}{% link content/PQSMods/LandControl/LandClasses.md %}) provided by LandControl. Scatters are 3D meshed objects that are generated on the surface and can have various configurable features added via the `Components` subnode.
7
7
8
8
**Subnodes**
9
9
*[Material { }]({{ site.baseurl }}{% link content/PQSMods/LandControl/ScatterMaterialType.md %})
Copy file name to clipboardexpand all lines: content/PQSMods/VertexHeightNoise.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: default
3
3
title: VertexHeightNoise
4
4
---
5
5
6
-
The `VertexHeightNoise` PQSMod is a mod that adds height noise to the terrain. This makes the terrain bumpier, though the "style" of bumps/features change with the noise type.
6
+
The `VertexHeightNoise` PQSMod is a mod that adds height noise to the terrain. This makes the terrain bumpier, though the "style" of bumps/features change with the noise type.
7
7
The noise is also additive, meaning that instead of overwriting the terrain altitude, it simply adds or subtracts from it.
Copy file name to clipboardexpand all lines: content/Properties/Properties.md
+3-4
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,13 @@ layout: default
3
3
title: Properties
4
4
---
5
5
6
-
The `Properties { }` node describes the body itself, and is a subnode of `Body { }`. Basic parameters like description, radius, gravity and biomes are specified here.
6
+
The `Properties { }` node describes the body itself, and is a subnode of `Body { }`. Basic parameters like description, radius, gravity and biomes are specified here.
7
7
8
-
### Subnodes
9
-
***
8
+
**Subnodes**
10
9
*[Biomes/Biome { }]({{ site.baseurl }}{% link content/Properties/Biome.md %})
11
10
*[ScienceValues { }]({{ site.baseurl }}{% link content/Properties/ScienceValues.md %})
Copy file name to clipboardexpand all lines: content/ScaledVersion/ScaledVersion.md
-1
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,6 @@ title: ScaledVersion
5
5
6
6
The `ScaledVersion { }` node in a configuration file for Kopernicus describes a less-detailed model of your planet that appears in the map view and from large distances.
7
7
8
-
9
8
**Subnodes**
10
9
*[Material { }]({{ site.baseurl }}{% link content/ScaledVersion/Material.md %}) = Updates to textures and atmosphere rims.
11
10
*[OnDemand { }]({{ site.baseurl }}{% link content/ScaledVersion/OnDemand.md %}) = Used for textures that should be loaded OnDemand.
0 commit comments