docs: add asciidoc docs for use with refinedsites

This commit is contained in:
raoulvdberge
2023-11-26 18:31:35 +01:00
parent 27442fbfac
commit b489a3db8f
237 changed files with 3175 additions and 0 deletions

View File

@@ -0,0 +1,7 @@
= Creative Wireless Crafting Monitor
:icon: wireless-crafting-monitor.png
:from: v1.2.1
The {doctitle} is the same as a regular xref:wireless-crafting-monitor.adoc[] but has infinite energy.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,7 @@
= Creative Wireless Fluid Grid
:from: v1.4.0-beta
:icon: wireless-fluid-grid.png
The {doctitle} is the same as a regular xref:wireless-fluid-grid.adoc[] but has infinite energy.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,7 @@
= Creative Wireless Grid
:icon: wireless-grid.png
:from: v0.5.3-alpha
The {doctitle} is the same as a regular xref:wireless-grid.adoc[] but has infinite energy.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,19 @@
= Wireless networking
- xref:networks-over-long-distances.adoc[]
== Wireless tools
- xref:wireless-transmitter.adoc[]
- xref:wireless-grid.adoc[]
- xref:creative-wireless-grid.adoc[]
- xref:wireless-fluid-grid.adoc[]
- xref:creative-wireless-fluid-grid.adoc[]
- xref:wireless-crafting-monitor.adoc[]
- xref:creative-wireless-crafting-monitor.adoc[]
== Wireless networks
- xref:network-card.adoc[]
- xref:network-receiver.adoc[]
- xref:network-transmitter.adoc[]

View File

@@ -0,0 +1,7 @@
= Network Card
:from: v0.8.13-beta
:icon: network-card.png
A {doctitle} is an item that stores the coordinates of a xref:network-receiver.adoc[].
The player has to insert the {doctitle} in a xref:network-transmitter.adoc[].

View File

@@ -0,0 +1,13 @@
= Network Receiver
:icon: network-receiver.png
:from: v0.8.13-beta
The {doctitle} is the block that receives a signal from the xref:network-transmitter.adoc[].
In order for the {doctitle} to work reliably the {doctitle} has to be chunkloaded.
include::../../partials/recoloring.adoc[]
== Using Refined Storage v1.7.x or v1.8.x?
Cross dimensional functionality isn't available in this version.

View File

@@ -0,0 +1,15 @@
= Network Transmitter
:icon: network-transmitter.png
:from: v0.8.13-beta
A {doctitle} sends a network signal to a xref:network-receiver.adoc[] that is specified in the given xref:network-card.adoc[].
In order for the {doctitle} to work the xref:../networking/controller.adoc[] where the {doctitle} is connected to has to be chunkloaded.
The {doctitle} can work in the current dimension or across different dimensions.
include::../../partials/recoloring.adoc[]
== Using Refined Storage v1.7.x or v1.8.x?
Cross dimensional functionality isn't available in this version.

View File

@@ -0,0 +1,46 @@
= Networks over long distances
Refined Storage supports 2 scenarios for long distance networking:
- xref:../viewing-resources/how-to-view-resources.adoc#_wireless_access[Viewing your resources wirelessly]
- Extending a network over a long distance without using cables (see below)
== The problem
Sometimes, you may have different areas all scattered throughout your world.
Here is the problem: you want access to your Refined Storage system on all of those areas.
You could lay xref:../networking/cable.adoc[] from your base to every area, but what if said area is 1000 blocks away?
Are you really going to craft 1000 xref:../networking/cable.adoc[cables]?
Didn't think so.
== The solution
Use the xref:network-transmitter.adoc[] and xref:network-receiver.adoc[].
Simply craft a xref:network-transmitter.adoc[] and connect it to your Refined Storage system in your main base.
Next up, craft a xref:network-card.adoc[].
I'll be telling what you need this for in a second, bear with me.
After crafting a xref:network-card.adoc[], craft a xref:network-receiver.adoc[] and place it in the area far away from your base.
Take the xref:network-card.adoc[] and right click it on the xref:network-receiver.adoc[].
Put the xref:network-card.adoc[] in the xref:network-transmitter.adoc[] so the xref:network-transmitter.adoc[] knows where to send a signal to.
And now you are done.
Simply connect machines to your xref:network-receiver.adoc[] according to the normal machine connecting rules.
I suppose you could treat the xref:network-receiver.adoc[] as a xref:...
== One very important thing to note
The xref:../networking/controller.adoc[] in your main base and the xref:network-receiver.adoc[] in the other area **both** have to be chunkloaded **before** linking it to the network.
After linking, both areas have to stay chunkloaded.
== Using Refined Storage v1.7.x or v1.8.x?
Cross dimensional functionality isn't available in this version.

View File

@@ -0,0 +1,39 @@
= Wireless Crafting Monitor
:icon: wireless-crafting-monitor.png
:from: v1.2.1
With the {doctitle} the player can see what is crafting from anywhere.
To activate the {doctitle}, the player has to right click the {doctitle} on a xref:../networking/controller.adoc[].
If you're playing on Refined Storage v1.7.x or higher you can bind the {doctitle} by right clicking on any connected network device.
To use the {doctitle} the item needs Forge Energy.
You'll have to charge it in a block that charges items from another mod.
After doing all these steps, the {doctitle} is still missing a signal from the system.
Add at least 1 xref:wireless-transmitter.adoc[] to the network to get a basic range of 16 blocks.
If the {doctitle} is ready for use, it will light up blue.
== Troubleshooting
Sometimes, the {doctitle} doesn't open or stays grey.
To enable it make sure that:
- The {doctitle} is bound to a xref:../networking/controller.adoc[]
- There is at least 1 xref:wireless-transmitter.adoc[] connected to the network
- That you are in range of the xref:wireless-transmitter.adoc[]
- The xref:../networking/controller.adoc[] block is still in the world on the place where you bound it to
== Energy behavior
The {doctitle} draws energy on following actions:
[cols="1,1"]
|===
|Action|Amount of Forge Energy used
|Opening the {doctitle|35 FE
|Cancelling a task|4 FE
|Cancelling all tasks|5 FE
|===

View File

@@ -0,0 +1,39 @@
= Wireless Fluid Grid
:icon: wireless-fluid-grid.png
:from: v1.4.0-beta
With the {doctitle} the player can access their fluids from anywhere.
To activate the {doctitle}, the player has to right click the {doctitle} on a xref:../networking/controller.adoc[].
If you're playing on Refined Storage v1.7.x or higher you can bind the {doctitle} by right clicking on any connected network device.
To use the {doctitle} the item needs Forge Energy.
You'll have to charge it in a block that charges items from another mod.
After doing all these steps, the {doctitle} is still missing a signal from the system.
Add at least 1 xref:wireless-transmitter.adoc[] to the network to get a basic range of 16 blocks.
If the {doctitle} is ready for use, it will light up blue.
== Troubleshooting
Sometimes, the {doctitle} doesn't open or stays gray.
To enable it make sure that:
- The {doctitle} is bound to a xref:../networking/controller.adoc[]
- There is at least 1 xref:wireless-transmitter.adoc[] connected to the network
- That you are in range of the xref:wireless-transmitter.adoc[]
- The xref:../networking/controller.adoc[] block is still in the world on the place where you bound it to
== Energy behavior
The {doctitle} draws energy on following actions:
[cols="1,1"]
|===
|Action|Amount of Forge Energy used
|Opening the {doctitle}|30 FE
|Pulling a fluid from storage|3 FE
|Pushing a fluid to storage|3 FE
|===

View File

@@ -0,0 +1,39 @@
= Wireless Grid
:from: v0.3.0-alpha
:icon: wireless-grid.png
With the {doctitle} the player can access their items from anywhere.
To activate the {doctitle}, the player has to right click the {doctitle} on a xref:../networking/controller.adoc[].
If you're playing on Refined Storage v1.7.x or higher you can bind the {doctitle} by right clicking on any connected network device.
To use the {doctitle} the item needs Forge Energy (FE).
You'll have to charge it in a block that charges items from another mod.
After doing all these steps, the {doctitle} is still missing a signal from the storage network.
Add at least 1 xref:wireless-transmitter.adoc[] to the network to get a basic range of 16 blocks.
If the {doctitle} is ready for use, it will light up blue.
== Troubleshooting
Sometimes, the {doctitle} doesn't open or stays gray.
To enable it make sure that:
- The {doctitle} is bound to a xref:../networking/controller.adoc[]
- There is at least 1 xref:wireless-transmitter.adoc[] connected to the network
- That you are in range of the xref:wireless-transmitter.adoc[]
- The xref:../networking/controller.adoc[] block is still in the world on the place where you bound it to
== Energy behavior
The {doctitle} draws energy on following actions:
[cols="1,1"]
|===
|Action|Amount of Forge Energy used
|Opening the {doctitle}|30 FE
|Pulling an item from storage|3 FE
|Pushing an item to storage|3 FE
|===

View File

@@ -0,0 +1,31 @@
= Wireless Transmitter
:icon: wireless-transmitter.png
:from: v0.6.0-alpha
The {doctitle} is used to send signals to wireless network items in Refined Storage.
== Range
The default range is 16 blocks, but can be upgraded with xref:../upgrades/range-upgrade.adoc[range upgrades].
=== Bigger range
Keep in mind, **you are not limited to 1 {doctitle}**!
You can spread multiple around in your world, each maximally upgraded with xref:../upgrades/range-upgrade.adoc[range upgrades].
Note that every {doctitle} needs to be connected to the network through a xref:../networking/cable.adoc[] or xref:network-receiver.adoc[].
== Placing transmitters efficiently
Placing 2 {doctitle}s just next to each other will not do that much.
The wireless signal starts from the {doctitle}'s position, so, if you place 2 transmitters next to each other you'll only have a net gain of 1 block.
Instead, you have to spread your wireless transmitters around.
include::../../partials/recoloring.adoc[]
== Applicable upgrades
- xref:../upgrades/range-upgrade.adoc[]