docs: add asciidoc docs for use with refinedsites
This commit is contained in:
32
docs/partials/fluid-storage-block.adoc
Normal file
32
docs/partials/fluid-storage-block.adoc
Normal file
@@ -0,0 +1,32 @@
|
||||
The {doctitle} is a block that provides the system with storage.
|
||||
It is similar to the xref:../pages/storage/index.adoc#_fluid_storage_disks[fluid storage disk], but can be placed in the world.
|
||||
|
||||
When breaking the {doctitle}, the fluids that it holds persist, so you won't lose any of your fluids.
|
||||
|
||||
The {doctitle} won't despawn when dropped in the world.
|
||||
|
||||
== 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 fluid from entering the {doctitle}.
|
||||
|
||||
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
|
||||
|
||||
== Uncrafting
|
||||
|
||||
Sneak and right click while holding the empty {doctitle} to retrieve the various parts back:
|
||||
|
||||
- The corresponding xref:../pages/storage/index.adoc#_fluid_storage_parts[Fluid Storage Part]
|
||||
- xref:../pages/utility/basic-processor.adoc[]
|
||||
- xref:../pages/utility/machine-casing.adoc[]
|
||||
11
docs/partials/fluid-storage-disk.adoc
Normal file
11
docs/partials/fluid-storage-disk.adoc
Normal file
@@ -0,0 +1,11 @@
|
||||
A {doctitle} is an item where items from the storage system are stored on.
|
||||
It has to be put in a xref:../pages/storage/disk-drive.adoc[].
|
||||
|
||||
The {doctitle} won't despawn when dropped in the world.
|
||||
|
||||
== Uncrafting
|
||||
|
||||
Sneak and right click while holding the empty {doctitle} to retrieve the various parts back:
|
||||
|
||||
- The corresponding xref:../pages/storage/index.adoc#_fluid_storage_parts[fluid storage part]
|
||||
- xref:../pages/storage/storage-housing.adoc[]
|
||||
1
docs/partials/processor.adoc
Normal file
1
docs/partials/processor.adoc
Normal file
@@ -0,0 +1 @@
|
||||
The {doctitle} is used to craft the various Refined Storage devices.
|
||||
6
docs/partials/recoloring.adoc
Normal file
6
docs/partials/recoloring.adoc
Normal file
@@ -0,0 +1,6 @@
|
||||
== Recoloring
|
||||
|
||||
You can recolor the {doctitle} in 2 ways:
|
||||
|
||||
- Using a dye on the {doctitle}
|
||||
- Combining the block with a dye as a crafting recipe
|
||||
52
docs/partials/search-box.adoc
Normal file
52
docs/partials/search-box.adoc
Normal file
@@ -0,0 +1,52 @@
|
||||
== Search box modes
|
||||
|
||||
[cols="1,1"]
|
||||
|===
|
||||
|Type|Description
|
||||
|
||||
|Normal|The default search box mode
|
||||
|Normal (autoselected)|Autoselects the search box
|
||||
|JEI synchronized|Synchronizes the search box with JEI
|
||||
|JEI synchronized (autoselected)|Synchronizes the search box with JEI and autoselects the search box
|
||||
|JEI synchronized (two-way)|Synchronizes the search box with JEI and synchronizes JEI with the search box
|
||||
|JEI synchronized (two-way autoselected)|Synchronizes the search box with JEI, synchronizes JEI with the search box and autoselects the search box
|
||||
|===
|
||||
|
||||
== Search box filters
|
||||
|
||||
=== Mod ID or name
|
||||
|
||||
Prefix your search query with `@` followed by the mod ID or name to only show items of said mod.
|
||||
|
||||
You can also give search terms after that, so it'll only display certain items of that mod.
|
||||
|
||||
For example:
|
||||
|
||||
- `@ic2` will only show link:https://minecraft.curseforge.com/projects/industrial-craft[IndustrialCraft 2] items and blocks
|
||||
- `@ic2 nuclear` will only show link:https://minecraft.curseforge.com/projects/industrial-craft[IndustrialCraft 2] items and blocks that have "nuclear" in its name
|
||||
|
||||
=== Tooltip
|
||||
|
||||
Prefix your search query with `#` followed by the tooltip text to search for.
|
||||
|
||||
=== Ore dictionary (Refined Storage 1.6.x or lower)
|
||||
|
||||
Prefix your search query with `$` followed by the ore dictionary name.
|
||||
|
||||
For example: `$ingot` will only show ingots, because those are listed as `ingotIron`, `ingotGold`, ... in the ore dictionary.
|
||||
|
||||
=== Tags (Refined Storage 1.7.x or higher)
|
||||
|
||||
Prefix your search query with `$` followed by the tag name.
|
||||
|
||||
For example: `$gem` will show all items marked as a gem in the item tags.
|
||||
|
||||
=== Searching multiple items
|
||||
|
||||
You can use the `|` symbol to search for multiple items at once.
|
||||
|
||||
For example: to look for ingots and dirt, use: `ingot|dirt`.
|
||||
|
||||
== Search box history
|
||||
|
||||
Use the up and down arrow keys to scroll through the search box history.
|
||||
32
docs/partials/storage-block.adoc
Normal file
32
docs/partials/storage-block.adoc
Normal file
@@ -0,0 +1,32 @@
|
||||
The {doctitle} is a block that provides the system with storage.
|
||||
It is similar to the xref:../pages/storage/index.adoc#_storage_disks[storage disk], but can be placed in the world.
|
||||
|
||||
When breaking the {doctitle}, the items that it holds persist, so you won't lose any of your items.
|
||||
|
||||
The {doctitle} won't despawn when dropped in the world.
|
||||
|
||||
== 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 from entering the {doctitle}.
|
||||
|
||||
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
|
||||
|
||||
== Uncrafting
|
||||
|
||||
Sneak and right click while holding the empty {doctitle} to retrieve the various parts back:
|
||||
|
||||
- The corresponding xref:../pages/storage/index.adoc#_storage_parts[Storage Part]
|
||||
- xref:../pages/utility/basic-processor.adoc[]
|
||||
- xref:../pages/utility/machine-casing.adoc[]
|
||||
11
docs/partials/storage-disk.adoc
Normal file
11
docs/partials/storage-disk.adoc
Normal file
@@ -0,0 +1,11 @@
|
||||
A {doctitle} is an item where items from the storage network are stored on.
|
||||
It has to be put in a xref:../pages/storage/disk-drive.adoc[].
|
||||
|
||||
The {doctitle} won't despawn when dropped in the world.
|
||||
|
||||
== Uncrafting
|
||||
|
||||
Sneak and right click while holding the empty {doctitle} to retrieve the various parts back:
|
||||
|
||||
- The corresponding xref:../pages/storage/index.adoc#_storage_parts[storage part]
|
||||
- xref:../pages/storage/storage-housing.adoc[]
|
||||
Reference in New Issue
Block a user