Skip to content

Commit

Permalink
Docs: A few more pages (#139)
Browse files Browse the repository at this point in the history
* Docs: Added some cross links

* Docs: Added Profiles page

* Docs: Added Resources page

* Docs: Added some more cross links

* Docs: Added Kerbals page
  • Loading branch information
PiezPiedPy authored and steamport committed Jul 14, 2018
1 parent 4dd6807 commit 0f636a0
Show file tree
Hide file tree
Showing 10 changed files with 382 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There is a help file on GitHub for those wishing to report bugs or contribute to

**I want to add support for Kerbalism to my parts**

- Add the appropriate modules to your parts. Check the `Kerbalism documentation`_ for the module specifications.
- Add the appropriate modules to your parts. Check the `Kerbalism modules`_ documentation for the module specifications.

**I want to interact with Kerbalism in my code**

Expand Down Expand Up @@ -57,7 +57,7 @@ This mod is released under the Unlicense_. For more information, please refer to
.. _CONTRIBUTING.md: https://github.com/steamp0rt/Kerbalism/tree/master/CONTRIBUTING.md
.. _Kerbalism KSP forums thread: https://forum.kerbalspaceprogram.com/index.php?/topic/172400-131144-kerbalism-v171/
.. _GitHub Kerbalism Issues: https://github.com/steamp0rt/Kerbalism/issues
.. _Kerbalism documentation: https://kerbalism.readthedocs.io/en/latest/
.. _Kerbalism modules: modders/modules.html
.. _System/API.cs: https://github.com/steamp0rt/Kerbalism/tree/master/src/System/API.cs
.. _Unlicense: https://github.com/steamp0rt/Kerbalism/tree/master/LICENSE

2 changes: 2 additions & 0 deletions docs/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Documentation Table of Contents
Reliability <reliability>
Signal <signal>
Science <science>
Resources <resources>
Kerbals <kerbals>
GUI <gui>
Parts <parts>
Automation <automation>
Expand Down
2 changes: 1 addition & 1 deletion docs/gui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ This panel allows you to visualize files stored in the vessels hard drive, flag

Device manager
--------------
This panel will show the control status of all components in a vessel, it is also used as the editor for the automation scripts.
This panel will show the control status of all components in a vessel, it is also used as the editor for the `automation <automation.html>`_ scripts.

.. image:: ../misc/img/gui/dev-manager.png

Expand Down
10 changes: 5 additions & 5 deletions docs/habitat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ Some pseudo-resources are added to each habitat. Each one is used to simulate th

Atmospheric control
-------------------
Atmospheric conditions inside a vessel are regulated by Life Support Systems (LSS) fitted into manned parts or by the External Life Support Unit (ECLSS).
Atmospheric conditions inside a vessel are regulated by Life Support Systems (`LSS <kerbals.html#lss>`_) fitted into manned parts or by the External Life Support Unit (`ECLSS <kerbals.html#lss>`_).
Each vessel has a number of configurable LSS slots that can be configured into an assortment of different LSS processes. The number of slots is upgradeable by purchasing the Slot Upgrade in the Electronics section of the Tech Tree. Also as you progress through the Tech Tree more options become available for the LSS slots.

The internal atmospheric pressure is regulated by the Pressure Controller, this unit is used to overcome the losses from leaks and for pressurizing inflatable habitats.
The internal atmospheric pressure is regulated by the `Pressure Controller <kerbals.html#lss>`_, this unit is used to overcome the losses from leaks and for pressurizing inflatable habitats.

The CO2 level is regulated by the Scrubber, this unit is used to scrub from the atmosphere the CO2 that the Kerbal's exhale. The greenhouse can also be used to remove CO2 from the atmosphere.
The CO2 level is regulated by the `Scrubber <kerbals.html#lss>`_, this unit is used to scrub from the atmosphere the CO2 that the Kerbal's exhale. The `greenhouse <kerbals.html#greenhouse>`_ can also be used to remove CO2 from the atmosphere.

The humidity level is regulated by the Humidity Controller, this unit removes the excess moisture in the atmosphere and recycles the moisture into clean water.
The humidity level is regulated by the `Humidity Controller <kerbals.html#lss>`_, this unit removes the excess moisture in the atmosphere and recycles the moisture into clean water.

----------

Expand All @@ -60,7 +60,7 @@ When a habitat transitions from the enabled to the disabled state or vise versa,
Inflatable habitats
-------------------

If a habitat is inflatable, its inflate/deflate animation will be driven by the actual pressure of the part. Note that pressurizing a large habitat with a small pressure controller can take a long time. For example the mk1 pods pressure control will take approx 3 days to inflate the Gravity Ring. So remember to add enough pressure controllers for the job. You wouldn't want to blow up a bouncy castle with your mouth :/
If a habitat is inflatable, its inflate/deflate animation will be driven by the actual pressure of the part. Note that pressurizing a large habitat with a small `pressure controller <kerbals.html#lss>`_ can take a long time. For example the mk1 pods pressure control will take approx 3 days to inflate the Gravity Ring. So remember to add enough `pressure controllers <kerbals.html#lss>`_ for the job. You wouldn't want to blow up a bouncy castle with your mouth :/

----------

Expand Down
13 changes: 5 additions & 8 deletions docs/intro.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _intro:

|Kerbalism|
.. image:: ../misc/img/banner.png

Introduction
============
Expand Down Expand Up @@ -45,17 +45,14 @@ These are the mechanics that are simulated

----------

Resources
---------
`Resources <resources.html>`_
-----------------------------

- consumption and production in background

----------

Kerbals
-------
`Kerbals <kerbals.html>`_
-------------------------

- biological and psychological needs, environmental hazards


.. |Kerbalism| image:: ../misc/img/banner.png
77 changes: 77 additions & 0 deletions docs/kerbals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
.. _kerbals:

Kerbals
=======

Biological needs
----------------
Kerbals need a constant supply of basic resources, Food, Water and Oxygen otherwise they will eventually perish.

+-----------+---------+-----------------+-------------------+---------------+
| RULE | CONSUME | PRODUCE | MASS PER-DAY (Kg) | UNITS PER-DAY |
+===========+=========+=================+===================+===============+
| Eating | Food | Waste | 1.77 | 6.29 |
+-----------+---------+-----------------+-------------------+---------------+
| Drinking | Water | WasteWater | 2.42 | 2.42 |
+-----------+---------+-----------------+-------------------+---------------+
| Breathing | Oxygen | WasteAtmosphere | 0.84 | 595 |
+-----------+---------+-----------------+-------------------+---------------+

---------

Psychological needs
-------------------
Kerbals will suffer mental breakdown after some time, it can be increased by providing.

- More habitat volume per-capita.
- A pressurized habitat.
- Basic `comforts <habitat.html#comforts>`_.

---------

Environmental hazards
---------------------
Kerbals will die if environmental conditions get out of hand, such as.

- *CO2 poisoning* from being exposed to high *CO2* levels (above 2%) in the internal atmosphere for too long. *CO2* levels are maintained by using Scrubbers and/or Greenhouses.

- Exposed to extreme levels of *humidity* (above 95%) in the internal atmosphere for too long. *Humidity* is maintained at a constant 60% by using the Humidity controllers.

- Exposed to temperatures outside of the *survivable range*. The internal temperature in a vessel is maintained constantly within the *survivable range* if there is enough *ElectricCharge* present. The climatization system uses *ElectricCharge* in proportion to the volume of the habitat to climatize and the difference between the *external* temperature and the *survivable range*.

- Exposed to extreme levels of *radiation*. Radiation belts have extremely high levels, and *solar storms* will dramatically increase the radiation for all vessels in a region temporarily. *Shielding* can be specified per-part in the VAB to reduce the environmental radiation reaching the internal habitat.

---------

LSS
---
Each pod or the External LSS Unit (ECLSS) can be configured with Life Support System setups from among the following.

+---------------------+---------------------------------------------------------------------------------+-----------------------+
| ECLSS SETUP | DESCRIPTION | TECH REQUIRED |
+=====================+=================================================================================+=======================+
| Scrubber | Sequester CO2 from the internal atmosphere | |
+---------------------+---------------------------------------------------------------------------------+-----------------------+
| Pressure control | Consume Nitrogen to keep the internal pressure at an acceptable level | Engineering 101 |
+---------------------+---------------------------------------------------------------------------------+-----------------------+
| Humidity controller | Extract potable water from the internal atmosphere and maintain humidity at 60% | Survivability |
+---------------------+---------------------------------------------------------------------------------+-----------------------+
| Water recycler | Extract potable water, ammonia and CO2 out of waste water | Space Exploration |
+---------------------+---------------------------------------------------------------------------------+-----------------------+
| Waste processor | Extract ammonia out of organic waste | Advanced Exploration |
+---------------------+---------------------------------------------------------------------------------+-----------------------+
| Monoprop fuel cell | Burn monoprop and O2, producing EC with by-products of water and nitrogen | Advanced Electrics |
+---------------------+---------------------------------------------------------------------------------+-----------------------+

---------

Greenhouse
----------
The greenhouse growth is configured to.

- consume *Water* and *Ammonia*.
- consume *CO2* from the atmosphere and/or pressurized tanks.
- consume *ElectricCharge* for the artificial lighting lamps, when their use is required.
- require an internal pressure of at least 10kPA.
- require radiation levels not in excess of 0.03 rad/h.
- produce *Oxygen* as a by-product.
3 changes: 1 addition & 2 deletions docs/modders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,5 @@ This section is for those who wish to modify Kerbalism, it contains information
:maxdepth: 5

Profiles <modders/profile>
Rules <modders/rules>
Modules <modders/modules>
Radiation <modders/radiation>
Modules <modders/modules>

0 comments on commit 0f636a0

Please sign in to comment.