docs: add asciidoc docs for use with refinedsites
This commit is contained in:
7
docs/pages/networking/cable.adoc
Normal file
7
docs/pages/networking/cable.adoc
Normal file
@@ -0,0 +1,7 @@
|
||||
= Cable
|
||||
:from: v0.3.0-alpha
|
||||
:icon: cable.png
|
||||
|
||||
{doctitle} is used to connect devices to the xref:controller.adoc[].
|
||||
|
||||
They are not always necessary, as long as the devices are next to each other in any direction a connection will be established as well.
|
||||
37
docs/pages/networking/controller.adoc
Normal file
37
docs/pages/networking/controller.adoc
Normal file
@@ -0,0 +1,37 @@
|
||||
= Controller
|
||||
:from: v0.3.0-alpha
|
||||
:icon: controller.png
|
||||
|
||||
The {doctitle} is the core of the Refined Storage network.
|
||||
You need to connect all the Refined Storage devices to this block.
|
||||
|
||||
== Connecting devices
|
||||
|
||||
You are supposed to connect every device that depends on the storage network connection to the {doctitle}.
|
||||
|
||||
You can connect devices with xref:cable.adoc[cables].
|
||||
|
||||
xref:cable.adoc[Cables] are not always necessary, as long as the devices are next to each other in any direction a connection will be established as well.
|
||||
|
||||
== Energy
|
||||
|
||||
The {doctitle} accepts and consumes Forge Energy (FE).
|
||||
Most mods have a way to generate energy, therefore Refined Storage doesn't come by itself with a way to generate energy.
|
||||
|
||||
- The energy is extracted per tick.
|
||||
- The amount of energy that is extracted depends on the amount of devices, and which devices.
|
||||
- Every device type consumes another amount of energy.
|
||||
- You can see how many energy each device consumes by right clicking the {doctitle}.
|
||||
|
||||
If the {doctitle} runs out of energy, the network will be turned off until there is sufficient energy provided again.
|
||||
|
||||
When the {doctitle} is broken, it will maintain its energy.
|
||||
|
||||
== Limits
|
||||
|
||||
Each Refined Storage network can only have a single {doctitle}.
|
||||
It doesn't make sense to connect multiple controllers on the same network.
|
||||
|
||||
If you connect another {doctitle} to an already existing network, the {doctitle} will break as an item in the world.
|
||||
|
||||
include::../../partials/recoloring.adoc[]
|
||||
9
docs/pages/networking/creative-controller.adoc
Normal file
9
docs/pages/networking/creative-controller.adoc
Normal file
@@ -0,0 +1,9 @@
|
||||
= Creative Controller
|
||||
:from: v0.3.0-alpha
|
||||
:icon: controller.png
|
||||
|
||||
The {doctitle} is the same as a regular xref:controller.adoc[] but has infinite energy.
|
||||
|
||||
It can only be obtained in creative mode.
|
||||
|
||||
include::../../partials/recoloring.adoc[]
|
||||
30
docs/pages/networking/detector.adoc
Normal file
30
docs/pages/networking/detector.adoc
Normal file
@@ -0,0 +1,30 @@
|
||||
= Detector
|
||||
:icon: detector.png
|
||||
:from: v0.3.0-alpha
|
||||
|
||||
The {doctitle} is a block that emits a redstone signal if an item, or fluid count matches a given amount.
|
||||
|
||||
It is also possible to be NBT or damage sensitive.
|
||||
|
||||
== Types of criteria
|
||||
|
||||
[cols="1,1"]
|
||||
|===
|
||||
|Criteria|Explanation
|
||||
|
||||
|<|Emits a signal when lower than the given amount
|
||||
|>|Emits a signal when higher than the given amount
|
||||
|=|Emits a signal when equal to the given amount
|
||||
|===
|
||||
|
||||
== Checking the total count in the storage
|
||||
|
||||
When no item/fluid, is specified, the criteria won't care about the count of a specific item/fluid, but rather the count of all items/fluids, in the storage.
|
||||
|
||||
== Amounts in fluid mode
|
||||
|
||||
When the {doctitle} is in fluid mode, the amount given is in millibuckets (mB).
|
||||
|
||||
If you want to check for 1 bucket of a fluid, use 1000, not 1.
|
||||
|
||||
include::../../partials/recoloring.adoc[]
|
||||
7
docs/pages/networking/index.adoc
Normal file
7
docs/pages/networking/index.adoc
Normal file
@@ -0,0 +1,7 @@
|
||||
= Networking
|
||||
|
||||
- xref:controller.adoc[]
|
||||
- xref:creative-controller.adoc[]
|
||||
- xref:cable.adoc[]
|
||||
- xref:detector.adoc[]
|
||||
- xref:relay.adoc[]
|
||||
9
docs/pages/networking/relay.adoc
Normal file
9
docs/pages/networking/relay.adoc
Normal file
@@ -0,0 +1,9 @@
|
||||
= Relay
|
||||
:from: v0.4.0-alpha
|
||||
:icon: relay.png
|
||||
|
||||
The Relay acts as xref:cable.adoc[], but can be turned on or off depending on the redstone configuration.
|
||||
|
||||
Devices connected after the Relay will be on or off depending if the {doctitle} is on.
|
||||
|
||||
include::../../partials/recoloring.adoc[]
|
||||
Reference in New Issue
Block a user