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,19 @@
= Crafting Grid
:icon: crafting-grid.png
:from: v0.3.0-alpha
The {doctitle} is the same as a regular xref:grid.adoc[], but has a crafting inventory.
When an item is crafted, it won't just clear the crafting slots, but it'll try to retrieve the same items from the storage network again.
== Recipe transferring
The {doctitle} integrates with link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)] so the player can use recipe transferring.
Refined Storage will warn you when you don't have the required item present in your inventory, storage network or crafting matrix.
Even with this warning, you can still transfer items.
If you don't have some required items, but autocrafting is available for said items, you can press CTRL + CLICK to start autocrafting for said items.
Note that you need a xref:../autocrafting/pattern.adoc[] configured for these items.
include::../../partials/recoloring.adoc[]

View File

@@ -0,0 +1,23 @@
= Fluid Grid
:from: v0.9.0-beta
:icon: fluid-grid.png
The {doctitle} is the same as a regular xref:grid.adoc[], but is used for viewing fluids in the fluid storage of your storage network.
== Inserting
To insert a fluid, players can shift click on a fluid container like a bucket in their player inventory while in the {doctitle} GUI.
The player can also click the fluid container in the GUI to insert it.
== Extracting
Players can extract the fluid by clicking on it.
The {doctitle} will then fill a bucket with the selected fluid.
Refined Storage will first search an empty bucket in your inventory.
If none is found, a bucket will be searched in your storage network.
Some fluids cannot be filled in a bucket, then the only way to extract those fluids is by using an xref:../input-and-output/exporter.adoc[].
include::../../partials/recoloring.adoc[]

View File

@@ -0,0 +1,93 @@
= Grid
:icon: grid.png
:from: v0.3.0-alpha
The {doctitle} is a block that allows access to the items and fluids in the storage network.
The player can extract items or fluids from the central GUI.
[#_controls]
== Controls
[cols="1,1"]
|===
| Type | Description
| Left click | Takes at most 64 items
| Right click | Takes at most 32 items
| Middle click | Takes 1 item (removed since v1.9.7)
| SHIFT + Mouse scroll in the player inventory | Pushes 1 item to or from the player's inventory (since v1.9.7)
| SHIFT + Mouse scroll in the {doctitle} inventory | Pushes 1 item to or from the {doctitle} inventory (since v1.9.7)
| CTRL + Mouse scroll | Pushes 1 item to or from the player's mouse (since v1.9.7)
| SHIFT | Pushes the items to the player's inventory
| SHIFT + CTRL | Forces the crafting window to open *even if the item or fluid is available*
| CTRL + X | Clears crafting matrix
| Right click on search bar | Clears the search query
| Tab | Selects the search bar when the {doctitle} isn't in autoselection mode
| When in the crafting start GUI, pressing SHIFT | Skips the crafting preview window
|===
== Sorting
The items or fluids in a {doctitle} can be sorted in various ways:
- By name
- By quantity
- By item ID
- Last modified
- InventoryTweaks sorting (only available if InventoryTweaks is installed)
The sorting direction can also be chosen (ascending or descending).
include::../../partials/search-box.adoc[]
== Filter
In the sidebar of the {doctitle} there are slots where the player can insert xref:../utility/filter.adoc[filters] to filter certain items in the {doctitle}.
== Tabs
A {doctitle} can also have tabs.
When clicking on the tab, only items configured in the xref:../utility/filter.adoc[] are visible.
To use tabs in the {doctitle}, make a xref:../utility/filter.adoc[] with an icon specified.
To have more than 4 tabs, put a xref:../utility/filter.adoc[] in a xref:../utility/filter.adoc[].
== Sizes
The size of any {doctitle} can be configured as well:
- Stretched (default)
- Small
- Medium
- Large
When choosing the stretched size, the {doctitle} will take up all the vertical screen space.
This can be limited through the `maxRowsStretch` config option.
== Display
The {doctitle} can be configured to only show craftable items or only non-craftable items.
By default, the tooltips for items in a {doctitle} are a little bit bigger to display the total item count and the last modified information.
This can be turned off by using the `detailedTooltip` config option.
By default, the {doctitle} uses a small font size to display item or fluid quantities.
Use the `largeFont` config option to change this.
== Remember search query
The {doctitle} can be configured to remember the search query when closing and re-opening the GUI.
You can do this by modifying the `rememberSearchQuery` config option.
== Prevent sorting while shift is down
By default, the {doctitle} doesn't perform sorting when you're shift clicking items out of the storage network.
This is done to prevent items and fluids shifting around your screen.
As soon as you stop pressing the shift key, the view is sorted again.
To disable this behavior, modify the `preventSortingWhileShiftIsDown` config option.
include::../../partials/recoloring.adoc[]

View File

@@ -0,0 +1,33 @@
= How to view resources
== Grid
You can use the xref:grid.adoc[], xref:crafting-grid.adoc[] or xref:fluid-grid.adoc[] to view resources in your network.
[#_wireless_access]
== Wireless access
Refined Storage has extensive wireless abilities to access your storage network remotely.
Craft a xref:../wireless-networking/wireless-grid.adoc[] and right click it on a xref:../networking/controller.adoc[].
Craft a xref:../wireless-networking/wireless-transmitter.adoc[] and add it to your network.
You can now access your storage in a radius around the xref:../wireless-networking/wireless-transmitter.adoc[].
Want a higher range?
Simply place multiple xref:../wireless-networking/wireless-transmitter.adoc[wireless transmitters] around your world, but not next to each other.
== Portable Grid
Want to access an individual xref:../storage/index.adoc#_storage_disks[storage disk]?
Use a xref:portable-grid.adoc[].
Give it energy and insert a disk, and you're good to go.
It doesn't depend on a storage network.
== Storage Monitor
Want to see how much you have of an item in your storage network?
Connect a xref:storage-monitor.adoc[] and configure an item to display.
You can then see how much you have of that item and interact with it by inserting or extracting multiple items at once.

View File

@@ -0,0 +1,8 @@
= Viewing resources
- xref:how-to-view-resources.adoc[]
- xref:grid.adoc[]
- xref:crafting-grid.adoc[]
- xref:fluid-grid.adoc[]
- xref:storage-monitor.adoc[]
- xref:portable-grid.adoc[]

View File

@@ -0,0 +1,28 @@
= Portable Grid
:icon: portable-grid.png
:from: v1.4.5-beta
The {doctitle} is a portable storage that isn't connected to a network.
It allows you to interact with a xref:../storage/index.adoc#_storage_disks[storage disk] while not being connected to a network.
As soon as you insert a xref:../storage/index.adoc#_storage_disks[storage disk], you can access the contents of your xref:../storage/index.adoc#_storage_disks[storage disk] in the grid view.
It's essentially a xref:../storage/disk-drive.adoc[] and xref:grid.adoc[] in one block or item.
It can be placed in the world, or, be used as a handheld device as well.
To place it in the world hold the {doctitle} while sneaking.
== Energy behavior
To use the {doctitle} the item or block needs Forge Energy (FE).
The {doctitle} draws energy on following actions:
[cols="1,1"]
|===
|Action|Amount of Forge Energy drawed
|Opening the {doctitle}|30 FE
|Extracting an item or fluid from storage|3 FE
|Inserting an item or fluid to storage|3 FE
|===

View File

@@ -0,0 +1,24 @@
= Storage Monitor
:icon: storage-monitor.png
:from: v1.4.1-beta
The {doctitle} is a block that displays the current amount of a certain item or fluid in your storage system.
== Configuration
Use SHIFT + right click on the block to open a GUI to configure the item or fluid being displayed.
== Item inserting and extracting
- You can extract the item specified from the system by left clicking
- Regular left click for a full stack (64 items)
- Shift left click for 1 of a stack (1 item)
- You can insert items from your inventory that match the item being displayed by right clicking
- Right click quickly to insert all items matching the item displayed in your
== Fluid inserting and extracting (since v1.8.1)
- You can extract the fluid specified in bucket from from the system by shift left clicking
- Make sure you have a bucket in your inventory or storage network
- You can insert fluids from your inventory that match the fluid being displayed by right clicking
- Make sure you have a fluid container in your inventory that contains the fluid you want to insert