forked from Kopernicus/Kopernicus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.tpl
executable file
·36 lines (26 loc) · 3.09 KB
/
README.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Kopernicus
==============================
{DATE}
* Created by: BryceSchroeder and Teknoman117 (aka. Nathaniel R. Lewis)
* Maintained by: Thomas P., NathanKell and KillAshley
* Additional Content by: Gravitasi, aftokino, KCreator, Padishar, Kragrathea, OvenProofMars, zengei, MrHappyFace, Sigma88, Majiir (CompatibilityChecker)
* Much thanks to Sarbian for ModuleManager and ModularFlightIntegrator
New in this version ({VERSION})
-------------------
{CHANGELOG}
Note - reparenting Kerbin or the Sun can cause the sky to be incorrect in the space center view. It is, however, correct in the flight view and the flight map view.
About
-----
Kopernicus is a KSP add-on that allows for modification of stock planets and the creation of new planets via modification of the system prefab. Why is this advantageous you might ask? Previous planet adder mods, such as Planet Factory, modified the live planetary system and had to keep multiple hacks actively running to provide these worlds. We strive to provide the least hacky solution by introducing planets into the game in the exact same manner Squad would.
Kopernicus is a one step process. It is started before the planetary system is created and rewrites a property called PSystemManager.Instance.systemPrefab. The game itself then creates *our* planetary system as if it were blessed by Squad themselves. The mod’s function ends here, and it terminates. Kopernicus introduced worlds require zero maintenance by third party code, all support is driven entirely by built in functionality. This yields an incredibly stable and incredibly flexible environment for planetary creation.
One caveat exists that prevents absolute control over a planetary system. Due to the way Squad defines how launch control and ship recovery work, a planet called Kerbin must exist and must have a reference body id of 1. While it is easy to provide this scenario, as a star to orbit and a single planet satisfies this, any would be universe architect needs to be aware so they don’t get mystery errors. The displayed name of the body (i.e. the celestialBody.bodyName property) can be changed after the spawn of the PSystem
Each celestial body in KSP has a property called “flightGlobalsIndex.” This number does not directly correspond to the reference id, but is related. Once all of the celestial bodies have been spawned, references to them are written into the localBodies list. This list is then sorted in increasing order of the flight globals index. The index the body is located at after the sort becomes the reference body id.
We have yet to see if removing or rearranging the other bodies causes any sort of errors in the science or contracts system.
Instructions
------------
- Copy the contents of the GameData/ folder to KSP’s GameData/ folder
- Launch KSP and enjoy!
- Please report any bugs you may find to either or both of the email addresses above.
Examples
----------
Selectively copy folders inside of [KopernicusExamples/](https://github.com/Kopernicus/KopernicusExamples/) into a GameData/KopernicusExamples/ folder. There are a number of examples of how to use Kopernicus.