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,16 @@
= Constructor
:icon: constructor.png
:from: v0.3.0-alpha
The {doctitle} places items or fluids from the storage network in the world.
No other blocks can be in front of the {doctitle} (except fluids) and it should be possible for the block to be placed (for example: saplings need dirt).
The {doctitle} can also drop items in the world instead of placing actual blocks.
When provided with a xref:../upgrades/stack-upgrade.adoc[], it'll drop stacks of items at a time.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]
- xref:../upgrades/crafting-upgrade.adoc[]

View File

@@ -0,0 +1,16 @@
= Destructor
:icon: destructor.png
:from: v0.3.0-alpha
The {doctitle} destroys blocks or fluids in front of it and puts the drops in the storage network.
The {doctitle} has the ability to only break certain blocks or fluids, with the whitelist and blacklist option.
Said whitelist and blacklist can be NBT or damage sensitive.
The {doctitle} can also pick up items in the world instead of destroying blocks.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/fortune-upgrade.adoc[]
- xref:../upgrades/silk-touch-upgrade.adoc[]

View File

@@ -0,0 +1,22 @@
= Disk Manipulator
:icon: disk-manipulator.png
:from: v1.0.5
The {doctitle} is a block that adds a fast way of transferring items between xref:../storage/index.adoc#_storage_disks[storage disks] or xref:../storage/index.adoc#_fluid_storage_disks[fluid storage disks] and the storage network.
== Whitelist or blacklist
The player can configure the {doctitle} to have a certain whitelist or blacklist of items that can be transferred.
The whitelist or blacklist can be configured to be NBT or damage sensitive.
== Mode
The player can also choose whether to insert items to the storage network or extract items from the storage network.
include::../../partials/recoloring.adoc[]
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]

View File

@@ -0,0 +1,18 @@
= Exporter
:icon: exporter.png
:from: v0.3.0-alpha
The {doctitle} extracts items or fluids from the storage network and inserts it in the inventory or tank in front of it.
Before being able to export anything, the player has to choose the items or fluids to export.
The chosen items can be configured to be NBT or damage sensitive.
The {doctitle} should face the block it's exporting to in a way that the wanted slot or fluid tank is possible to reach from that side.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]
- xref:../upgrades/crafting-upgrade.adoc[]
- xref:../upgrades/regulator-upgrade.adoc[]

View File

@@ -0,0 +1,26 @@
= Fluid Interface
:icon: fluid-interface.png
:from: v0.9.0-beta
The {doctitle} is the same as an xref:interface.adoc[] but for fluids.
It has 2 internal tanks, one for input and one for output.
== Input slot
The {doctitle} has an input slot to import the contents of fluid containers (like a filled bucket).
You can also interact with the input tank by using pipes from other mods.
== Output configuration
- Click a fluid container (like a filled bucket) in the "Out" slot to configure the output fluid.
- Use left or right click on the fluid to change the mB amount.
- Use shift to clear the fluid slot.
- You can also interact with the output tank by using pipes from other mods.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]
- xref:../upgrades/crafting-upgrade.adoc[]

View File

@@ -0,0 +1,37 @@
= Getting items in and out
So far, you know xref:../getting-started.adoc[how to add storage disks to your network and view them].
But how do you get those items in and out in an automated way?
This is a quick overview of all the devices that manipulate your storage.
== Exporter
If you want to get items out of your storage network, use an xref:exporter.adoc[] and connect it to an inventory where you want to export to.
Configure the filter slots of the xref:exporter.adoc[] to the items you want to export.
== Importer
If you want to get items in your storage network, use an xref:importer.adoc[] and connect it to an inventory where you want to import from.
== Interface
Want the best of both worlds?
Use an xref:interface.adoc[] to get importing and exporting functionality in one block.
== Constructor
To place blocks from your storage network in the world, use an xref:constructor.adoc[].
Configure the filter slots of the xref:constructor.adoc[] to the block you want to place.
== Destructor
To destroy and insert blocks from the world into your storage, use an xref:destructor.adoc[].
You can configure a whitelist or blacklist of blocks to destroy.
== Disk Manipulator
If you want to import from disks or export to a disk from the network, use a xref:disk-manipulator.adoc[].

View File

@@ -0,0 +1,18 @@
= Importer
:icon: importer.png
:from: v0.3.0-alpha
The {doctitle} imports items or fluids from an inventory in front of the block and inserts it in the storage network (if there is space).
By default, it will import all accessible slots (place the {doctitle} on the correct side, where the slot or fluid tank is reachable) but the player can use the whitelist or blacklist as well.
== Whitelist and blacklist
There is also a whitelist and blacklist option to only allow or forbid some items from entering the storage network.
The whitelist or blacklist can be configured to be NBT or damage sensitive.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]

View File

@@ -0,0 +1,12 @@
= Input and output
- xref:getting-items-in-and-out.adoc[]
- xref:importer.adoc[]
- xref:exporter.adoc[]
- xref:constructor.adoc[]
- xref:destructor.adoc[]
- xref:interface.adoc[]
- xref:fluid-interface.adoc[]
- xref:disk-manipulator.adoc[]
- xref:reader.adoc[]
- xref:writer.adoc[]

View File

@@ -0,0 +1,36 @@
= Interface
:icon: interface.png
:from: v0.4.0-alpha
The Interface is a block that acts as a combination of the xref:importer.adoc[] and the xref:exporter.adoc[].
== Importing
Let's talk about the difference between an xref:importer.adoc[] and the Interface for importing.
The xref:importer.adoc[] needs to be connected to an inventory to import items or fluids.
It has no internal inventory and you can't insert items directly to the xref:importer.adoc[.
In comparison with the xref:importer.adoc[] the Interface has an internal inventory to receive items and import them (through piping, hoppers, etc).
That internal inventory is accessible by opening the GUI and looking at the slots under "Interface Import").
The Interface does NOT extract items from adjacent inventories automatically, you have to actually insert them in the Interface through piping, hoppers, etc.
== Exporting
There is also an option for exporting items from the system.
These items can be piped out through a piping system from another mod, hoppers, etc.
It can be configured to be NBT or damage sensitive.
== Output configuration
- Click an item in the export slots to configure that to be exported.
- Use left or right click on the item to change the amount.
- Use shift to clear the slot.
== Applicable upgrades
- xref:../upgrades/speed-upgrade.adoc[]
- xref:../upgrades/stack-upgrade.adoc[]
- xref:../upgrades/crafting-upgrade.adoc[]

View File

@@ -0,0 +1,24 @@
= Reader
:icon: reader.png
:from: v1.4.0-beta
:to: v1.7.0-alpha
[.alert.alert-warning]
****
The {doctitle} has been removed in version v1.7.0-alpha.
****
A Reader has the ability to manage {doctitle} / xref:writer.adoc[] channels on a network.
The {doctitle} is a block that takes items, fluids, energy and / or a redstone signal.
The data will be transmitted to the configured channel and can be read out with a xref:writer.adoc[].
The {doctitle} doesn't auto-extract any of the supported types (with an exception to redstone signals).
You have to insert it manually.
== Supported types
- Items
- Fluids
- Energy
- Redstone

View File

@@ -0,0 +1,24 @@
= Writer
:icon: writer.png
:from: v1.4.0-beta
:to: v1.7.0-alpha
[.alert.alert-warning]
****
The {doctitle} has been removed in version v1.7.0-alpha.
****
A {doctitle} has the ability to manage xref:reader.adoc[] / {doctitle} channels on a network.
The {doctitle} is a block that exposes items, fluids, energy and / or a redstone signal from the bound channel.
The data that is received is sent from the xref:reader.adoc[].
The {doctitle} doesn't auto-push any of the supported types (with an exception to redstone signals).
You have to extract it manually.
== Supported types
- Items
- Fluids
- Energy
- Redstone