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,9 @@
= 1024k Fluid Storage Block
:icon: 1024k-fluid-storage-block.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-block.adoc[]
== Storage capacity
The {doctitle} can store 1024.000 millibuckets or 1024 buckets of any fluid.

View File

@@ -0,0 +1,9 @@
= 1024k Fluid Storage Disk
:icon: 1024k-fluid-storage-disk.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 1024.000 millibuckets or 1024 buckets of any fluid.

View File

@@ -0,0 +1,5 @@
= 1024k Fluid Storage Part
:icon: 1024k-fluid-storage-part.png
:from: v0.9.0-beta
The {doctitle} is used to craft the xref:1024k-fluid-storage-disk.adoc[] and xref:1024k-fluid-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 16k Storage Block
:icon: 16k-storage-block.png
:from: v0.3.0-alpha
include::../../partials/storage-block.adoc[]
== Storage capacity
The {doctitle} can store 16.000 items.

View File

@@ -0,0 +1,9 @@
= 16k Storage Disk
:icon: 16k-storage-disk.png
:from: v0.3.0-alpha
include::../../partials/storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 16.000 items.

View File

@@ -0,0 +1,5 @@
= 16k Storage Part
:icon: 16k-storage-part.png
:from: v0.3.0-alpha
The {doctitle} is used to craft the xref:16k-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 1k Storage Block
:icon: 1k-storage-block.png
:from: v0.3.0-alpha
include::../../partials/storage-block.adoc[]
== Storage capacity
The {doctitle} can store 1.000 items.

View File

@@ -0,0 +1,9 @@
= 1k Storage Disk
:icon: 1k-storage-disk.png
:from: v0.3.0-alpha
include::../../partials/storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 1.000 items.

View File

@@ -0,0 +1,5 @@
= 1k Storage Part
:icon: 1k-storage-part.png
:from: v0.3.0-alpha
The {doctitle} is used to craft the xref:1k-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 256k Fluid Storage Block
:icon: 256k-fluid-storage-block.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-block.adoc[]
== Storage capacity
The {doctitle} can store 256.000 millibuckets or 256 buckets of any fluid.

View File

@@ -0,0 +1,9 @@
= 256k Fluid Storage Disk
:icon: 256k-fluid-storage-disk.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 256.000 millibuckets or 256 buckets of any fluid.

View File

@@ -0,0 +1,5 @@
= 256k Fluid Storage Part
:icon: 256k-fluid-storage-part.png
:from: v0.9.0-beta
The {doctitle} is used to craft the xref:256k-fluid-storage-disk.adoc[] and xref:256k-fluid-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 4096k Fluid Storage Block
:icon: 4096k-fluid-storage-block.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-block.adoc[]
== Storage capacity
The {doctitle} can store 4096.000 millibuckets or 4096 buckets of any fluid.

View File

@@ -0,0 +1,9 @@
= 4096k Fluid Storage Disk
:icon: 4096k-fluid-storage-disk.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 4096.000 millibuckets or 4096 buckets of any fluid.

View File

@@ -0,0 +1,5 @@
= 4096k Fluid Storage Part
:icon: 4096k-fluid-storage-part.png
:from: v0.9.0-beta
The {doctitle} is used to craft the xref:4096k-fluid-storage-disk.adoc[] and xref:4096k-fluid-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 4k Storage Block
:icon: 4k-storage-block.png
:from: v0.3.0-alpha
include::../../partials/storage-block.adoc[]
== Storage capacity
The {doctitle} can store 4.000 items.

View File

@@ -0,0 +1,9 @@
= 4k Storage Disk
:icon: 4k-storage-disk.png
:from: v0.3.0-alpha
include::../../partials/storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 4.000 items.

View File

@@ -0,0 +1,5 @@
= 4k Storage Part
:icon: 4k-storage-part.png
:from: v0.3.0-alpha
The {doctitle} is used to craft the xref:4k-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 64k Fluid Storage Block
:icon: 64k-storage-block.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-block.adoc[]
== Storage capacity
The {doctitle} can store 64.000 millibuckets or 64 buckets of any fluid.

View File

@@ -0,0 +1,9 @@
= 64k Fluid Storage Disk
:icon: 64k-fluid-storage-disk.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 64.000 millibuckets or 64 buckets of any fluid.

View File

@@ -0,0 +1,5 @@
= 64k Fluid Storage Part
:icon: 64k-fluid-storage-part.png
:from: v0.9.0-beta
The {doctitle} is used to craft the xref:64k-fluid-storage-disk.adoc[] and xref:64k-fluid-storage-block.adoc[].

View File

@@ -0,0 +1,9 @@
= 64k Storage Block
:icon: 64k-storage-block.png
:from: v0.3.0-alpha
include::../../partials/storage-block.adoc[]
== Storage capacity
The {doctitle} can store 64.000 items.

View File

@@ -0,0 +1,9 @@
= 64k Storage Disk
:icon: 64k-storage-disk.png
:from: v0.3.0-alpha
include::../../partials/storage-disk.adoc[]
== Storage capacity
The {doctitle} can store 64.000 items.

View File

@@ -0,0 +1,5 @@
= 64k Storage Part
:icon: 64k-storage-part.png
:from: v0.3.0-alpha
The {doctitle} is used to craft the xref:64k-storage-block.adoc[].

View File

@@ -0,0 +1,11 @@
= Creative Fluid Storage Block
:icon: creative-fluid-storage-block.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-block.adoc[]
== Storage capacity
The {doctitle} can store an infinite amount of buckets.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,11 @@
= Creative Fluid Storage Disk
:icon: creative-fluid-storage-disk.png
:from: v0.9.0-beta
include::../../partials/fluid-storage-disk.adoc[]
== Storage capacity
The {doctitle} can store an infinite amount of buckets.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,11 @@
= Creative Storage Block
:icon: creative-storage-block.png
:from: v0.3.0-alpha
include::../../partials/storage-block.adoc[]
== Storage capacity
The {doctitle} can store an infinite amount of items.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,11 @@
= Creative Storage Disk
:icon: creative-storage-disk.png
:from: v0.3.0-alpha
include::../../partials/storage-disk.adoc[]
== Storage capacity
The {doctitle} can store an infinite amount of items.
It can only be obtained in creative mode.

View File

@@ -0,0 +1,23 @@
= Disk Drive
:icon: disk-drive.png
:from: v0.3.0-alpha
The Disk Drive is the block in which you store xref:index.adoc#_storage_disks[storage disks] or xref:index.adoc#_fluid_storage_disks[fluid storage disks].
== Priority
A (negative or positive) priority can be chosen (where a higher priority gets higher precedence to place items in).
== Whitelist and blacklist
There is also a whitelist and blacklist to only allow or forbid some items or fluids from entering the xref:index.adoc#_storage_disks[storage disks] or xref:index.adoc#_fluid_storage_disks[fluid storage disks] respectively.
The whitelist or blacklist can be configured to be NBT or damage sensitive.
== Mode
The Disk Drive has support for the following modes:
- Insert and extract (default)
- Insert only
- Extract only

View File

@@ -0,0 +1,23 @@
= External Storage
:from: v0.3.0-alpha
:icon: external-storage.png
The {doctitle} is a block that provides the storage network with storage of the inventory or fluid tank in front of the device.
== Priority
A (negative or positive) priority can be chosen (where a higher priority gets higher precedence to place items in).
== Whitelist and blacklist
There is also a whitelist and blacklist option to only allow or forbid some items or fluids from entering the connected inventory.
The whitelist or blacklist can be configured to be NBT or damage sensitive.
== Mode
The {doctitle} has support for the following modes:
- Insert and extract (default)
- Insert only
- Extract only

View File

@@ -0,0 +1,61 @@
= Storage
- xref:storing-externally.adoc[]
- xref:storing-fluids.adoc[]
== Network devices
- xref:disk-drive.adoc[]
- xref:external-storage.adoc[]
[#_storage_parts]
== Storage parts
- xref:1k-storage-part.adoc[]
- xref:4k-storage-part.adoc[]
- xref:16k-storage-part.adoc[]
- xref:64k-storage-part.adoc[]
[#_storage_disks]
== Storage disks
- xref:1k-storage-disk.adoc[]
- xref:4k-storage-disk.adoc[]
- xref:16k-storage-disk.adoc[]
- xref:64k-storage-disk.adoc[]
- xref:creative-storage-disk.adoc[]
[#_storage_blocks]
== Storage blocks
- xref:1k-storage-block.adoc[]
- xref:4k-storage-block.adoc[]
- xref:16k-storage-block.adoc[]
- xref:64k-storage-block.adoc[]
- xref:creative-storage-block.adoc[]
[#_fluid_storage_parts]
== Fluid storage parts
- xref:64k-fluid-storage-part.adoc[]
- xref:256k-fluid-storage-part.adoc[]
- xref:1024k-fluid-storage-part.adoc[]
- xref:4096k-fluid-storage-part.adoc[]
[#_fluid_storage_disks]
== Fluid storage disks
- xref:64k-fluid-storage-disk.adoc[]
- xref:256k-fluid-storage-disk.adoc[]
- xref:1024k-fluid-storage-disk.adoc[]
- xref:4096k-fluid-storage-disk.adoc[]
- xref:creative-fluid-storage-disk.adoc[]
[#_fluid_storage_blocks]
== Fluid storage blocks
- xref:64k-fluid-storage-block.adoc[]
- xref:256k-fluid-storage-block.adoc[]
- xref:1024k-fluid-storage-block.adoc[]
- xref:4096k-fluid-storage-block.adoc[]
- xref:creative-fluid-storage-block.adoc[]

View File

@@ -0,0 +1,7 @@
= Storage Housing
:icon: storage-housing.png
:from: v0.6.0-alpha
A Storage Housing is a xref:index.adoc#_storage_disks[storage disk] or xref:index.adoc#_fluid_storage_disks[fluid storage disk] without any xref:index.adoc#_storage_parts[storage part] or xref:index.adoc#_fluid_storage_parts[fluid storage part] assigned to it.
The player can craft another xref:index.adoc#_storage_disks[storage disk] or xref:index.adoc#_fluid_storage_disks[fluid storage disk] with this item by combining the Storage Housing with a xref:index.adoc#_storage_parts[storage part] or xref:index.adoc#_fluid_storage_parts[fluid storage part] respectively.

View File

@@ -0,0 +1,32 @@
= Storing externally
So far you've used xref:index.adoc#_storage_disks[storage disks] or xref:index.adoc#_storage_blocks[storage blocks].
What if you want to use a chest or another inventory as storage?
== The External Storage
Craft an xref:external-storage.adoc[] and connect it to an external inventory like a link:https://minecraft.gamepedia.com/Chest[Chest].
If you now insert items, they will go in the inventory.
You can also filter items that can enter the external inventory with the filter slots.
== Supported storages
The xref:external-storage.adoc[] supports every block that is an inventory.
Some examples:
- link:https://minecraft.gamepedia.com/Chest[Chests]
- Storage Drawers
- Regular drawers
- Drawer Controller
- Iron Chests
- etc...
== Using an External Storage alongside other storages
When you insert or extract an item from the storage network, Refined Storage will extract or insert from the storage with the highest priority first.
Simply give a storage a higher priority than the other one, and Refined Storage will prioritize correctly.
If the storage is full, Refined Storage will attempt to insert or extract from the next available storage, with a lower priority.

View File

@@ -0,0 +1,25 @@
= Storing fluids
As opposed to only item storage, Refined Storage is able to store fluids as well.
This is done in the entirely same way as item storages.
All the things you can do to manipulate items (with xref:../input-and-output/exporter.adoc[exporters] or xref:../input-and-output/importer.adoc[importers]) you can do with fluids as well.
== Storage
The same way as you connect item storages, you can connect fluid storages as well:
- xref:index.adoc#_fluid_storage_disks[Any fluid storage disk] in a xref:disk-drive.adoc[]
- xref:index.adoc#_fluid_storage_blocks[Any fluid storage block]
- xref:external-storage.adoc[] in fluid mode
== Accessing fluids
Use a xref:../viewing-resources/fluid-grid.adoc[].
== Manipulating fluids
Any block that would manipulate items can manipulate fluids as well by simply putting the block in fluid mode.
There is one exception to this: the xref:../input-and-output/interface.adoc[] has no fluid mode.
Use a xref:../input-and-output/fluid-interface.adoc[] instead.