diff --git a/docs/assets/1024k-fluid-storage-block.png b/docs/assets/1024k-fluid-storage-block.png new file mode 100644 index 0000000000..61c2da6347 Binary files /dev/null and b/docs/assets/1024k-fluid-storage-block.png differ diff --git a/docs/assets/1024k-fluid-storage-disk.png b/docs/assets/1024k-fluid-storage-disk.png new file mode 100644 index 0000000000..b8341a6c23 Binary files /dev/null and b/docs/assets/1024k-fluid-storage-disk.png differ diff --git a/docs/assets/1024k-fluid-storage-part.png b/docs/assets/1024k-fluid-storage-part.png new file mode 100644 index 0000000000..5969df906b Binary files /dev/null and b/docs/assets/1024k-fluid-storage-part.png differ diff --git a/docs/assets/16k-storage-block.png b/docs/assets/16k-storage-block.png new file mode 100644 index 0000000000..e719977f8b Binary files /dev/null and b/docs/assets/16k-storage-block.png differ diff --git a/docs/assets/16k-storage-disk.png b/docs/assets/16k-storage-disk.png new file mode 100644 index 0000000000..db706e3579 Binary files /dev/null and b/docs/assets/16k-storage-disk.png differ diff --git a/docs/assets/16k-storage-part.png b/docs/assets/16k-storage-part.png new file mode 100644 index 0000000000..dafa02728b Binary files /dev/null and b/docs/assets/16k-storage-part.png differ diff --git a/docs/assets/1k-storage-block.png b/docs/assets/1k-storage-block.png new file mode 100644 index 0000000000..e2e65a87b6 Binary files /dev/null and b/docs/assets/1k-storage-block.png differ diff --git a/docs/assets/1k-storage-disk.png b/docs/assets/1k-storage-disk.png new file mode 100644 index 0000000000..0a63e152f8 Binary files /dev/null and b/docs/assets/1k-storage-disk.png differ diff --git a/docs/assets/1k-storage-part.png b/docs/assets/1k-storage-part.png new file mode 100644 index 0000000000..ea0a224487 Binary files /dev/null and b/docs/assets/1k-storage-part.png differ diff --git a/docs/assets/256k-fluid-storage-block.png b/docs/assets/256k-fluid-storage-block.png new file mode 100644 index 0000000000..24fb290a2b Binary files /dev/null and b/docs/assets/256k-fluid-storage-block.png differ diff --git a/docs/assets/256k-fluid-storage-disk.png b/docs/assets/256k-fluid-storage-disk.png new file mode 100644 index 0000000000..8c89afc6dd Binary files /dev/null and b/docs/assets/256k-fluid-storage-disk.png differ diff --git a/docs/assets/256k-fluid-storage-part.png b/docs/assets/256k-fluid-storage-part.png new file mode 100644 index 0000000000..d11be7babe Binary files /dev/null and b/docs/assets/256k-fluid-storage-part.png differ diff --git a/docs/assets/4096k-fluid-storage-block.png b/docs/assets/4096k-fluid-storage-block.png new file mode 100644 index 0000000000..3ba040a4e4 Binary files /dev/null and b/docs/assets/4096k-fluid-storage-block.png differ diff --git a/docs/assets/4096k-fluid-storage-disk.png b/docs/assets/4096k-fluid-storage-disk.png new file mode 100644 index 0000000000..ace2ad40c7 Binary files /dev/null and b/docs/assets/4096k-fluid-storage-disk.png differ diff --git a/docs/assets/4096k-fluid-storage-part.png b/docs/assets/4096k-fluid-storage-part.png new file mode 100644 index 0000000000..bb2b7c3769 Binary files /dev/null and b/docs/assets/4096k-fluid-storage-part.png differ diff --git a/docs/assets/4k-storage-block.png b/docs/assets/4k-storage-block.png new file mode 100644 index 0000000000..12d262002f Binary files /dev/null and b/docs/assets/4k-storage-block.png differ diff --git a/docs/assets/4k-storage-disk.png b/docs/assets/4k-storage-disk.png new file mode 100644 index 0000000000..adf82e0fd2 Binary files /dev/null and b/docs/assets/4k-storage-disk.png differ diff --git a/docs/assets/4k-storage-part.png b/docs/assets/4k-storage-part.png new file mode 100644 index 0000000000..718e9350fd Binary files /dev/null and b/docs/assets/4k-storage-part.png differ diff --git a/docs/assets/64k-fluid-storage-block.png b/docs/assets/64k-fluid-storage-block.png new file mode 100644 index 0000000000..b95802f43b Binary files /dev/null and b/docs/assets/64k-fluid-storage-block.png differ diff --git a/docs/assets/64k-fluid-storage-disk.png b/docs/assets/64k-fluid-storage-disk.png new file mode 100644 index 0000000000..234f324872 Binary files /dev/null and b/docs/assets/64k-fluid-storage-disk.png differ diff --git a/docs/assets/64k-fluid-storage-part.png b/docs/assets/64k-fluid-storage-part.png new file mode 100644 index 0000000000..988d606f9e Binary files /dev/null and b/docs/assets/64k-fluid-storage-part.png differ diff --git a/docs/assets/64k-storage-block.png b/docs/assets/64k-storage-block.png new file mode 100644 index 0000000000..ba10c0bbc6 Binary files /dev/null and b/docs/assets/64k-storage-block.png differ diff --git a/docs/assets/64k-storage-disk.png b/docs/assets/64k-storage-disk.png new file mode 100644 index 0000000000..e866a471ba Binary files /dev/null and b/docs/assets/64k-storage-disk.png differ diff --git a/docs/assets/64k-storage-part.png b/docs/assets/64k-storage-part.png new file mode 100644 index 0000000000..a3d44de078 Binary files /dev/null and b/docs/assets/64k-storage-part.png differ diff --git a/docs/assets/advanced-processor.png b/docs/assets/advanced-processor.png new file mode 100644 index 0000000000..25fe3d3143 Binary files /dev/null and b/docs/assets/advanced-processor.png differ diff --git a/docs/assets/basic-processor.png b/docs/assets/basic-processor.png new file mode 100644 index 0000000000..58b08900dc Binary files /dev/null and b/docs/assets/basic-processor.png differ diff --git a/docs/assets/block-of-quartz-enriched-iron.png b/docs/assets/block-of-quartz-enriched-iron.png new file mode 100644 index 0000000000..1ba140d60e Binary files /dev/null and b/docs/assets/block-of-quartz-enriched-iron.png differ diff --git a/docs/assets/cable.png b/docs/assets/cable.png new file mode 100644 index 0000000000..ee54d636eb Binary files /dev/null and b/docs/assets/cable.png differ diff --git a/docs/assets/construction-core.png b/docs/assets/construction-core.png new file mode 100644 index 0000000000..c9dfb71937 Binary files /dev/null and b/docs/assets/construction-core.png differ diff --git a/docs/assets/constructor.png b/docs/assets/constructor.png new file mode 100644 index 0000000000..dd00acc716 Binary files /dev/null and b/docs/assets/constructor.png differ diff --git a/docs/assets/controller.png b/docs/assets/controller.png new file mode 100644 index 0000000000..856d5f825c Binary files /dev/null and b/docs/assets/controller.png differ diff --git a/docs/assets/cover.png b/docs/assets/cover.png new file mode 100644 index 0000000000..928f0ae739 Binary files /dev/null and b/docs/assets/cover.png differ diff --git a/docs/assets/crafter-manager.png b/docs/assets/crafter-manager.png new file mode 100644 index 0000000000..93231d3d8f Binary files /dev/null and b/docs/assets/crafter-manager.png differ diff --git a/docs/assets/crafter.png b/docs/assets/crafter.png new file mode 100644 index 0000000000..32c86bd4ef Binary files /dev/null and b/docs/assets/crafter.png differ diff --git a/docs/assets/crafting-grid.png b/docs/assets/crafting-grid.png new file mode 100644 index 0000000000..c48b9e9cb0 Binary files /dev/null and b/docs/assets/crafting-grid.png differ diff --git a/docs/assets/crafting-monitor.png b/docs/assets/crafting-monitor.png new file mode 100644 index 0000000000..6b9a169e08 Binary files /dev/null and b/docs/assets/crafting-monitor.png differ diff --git a/docs/assets/crafting-upgrade.png b/docs/assets/crafting-upgrade.png new file mode 100644 index 0000000000..5c56cbb79a Binary files /dev/null and b/docs/assets/crafting-upgrade.png differ diff --git a/docs/assets/creative-fluid-storage-block.png b/docs/assets/creative-fluid-storage-block.png new file mode 100644 index 0000000000..3962d1bbdb Binary files /dev/null and b/docs/assets/creative-fluid-storage-block.png differ diff --git a/docs/assets/creative-fluid-storage-disk.png b/docs/assets/creative-fluid-storage-disk.png new file mode 100644 index 0000000000..5384d27ee4 Binary files /dev/null and b/docs/assets/creative-fluid-storage-disk.png differ diff --git a/docs/assets/creative-portable-grid.png b/docs/assets/creative-portable-grid.png new file mode 100644 index 0000000000..6cf68e1c99 Binary files /dev/null and b/docs/assets/creative-portable-grid.png differ diff --git a/docs/assets/creative-storage-block.png b/docs/assets/creative-storage-block.png new file mode 100644 index 0000000000..963aa6b34a Binary files /dev/null and b/docs/assets/creative-storage-block.png differ diff --git a/docs/assets/creative-storage-disk.png b/docs/assets/creative-storage-disk.png new file mode 100644 index 0000000000..1ab6d8520e Binary files /dev/null and b/docs/assets/creative-storage-disk.png differ diff --git a/docs/assets/creative-wireless-crafting-monitor.png b/docs/assets/creative-wireless-crafting-monitor.png new file mode 100644 index 0000000000..aec7aa6769 Binary files /dev/null and b/docs/assets/creative-wireless-crafting-monitor.png differ diff --git a/docs/assets/creative-wireless-fluid-grid.png b/docs/assets/creative-wireless-fluid-grid.png new file mode 100644 index 0000000000..9d8fc29f2e Binary files /dev/null and b/docs/assets/creative-wireless-fluid-grid.png differ diff --git a/docs/assets/creative-wireless-grid.png b/docs/assets/creative-wireless-grid.png new file mode 100644 index 0000000000..81aa1dc30e Binary files /dev/null and b/docs/assets/creative-wireless-grid.png differ diff --git a/docs/assets/cut-silicon.png b/docs/assets/cut-silicon.png new file mode 100644 index 0000000000..6c2ae20a83 Binary files /dev/null and b/docs/assets/cut-silicon.png differ diff --git a/docs/assets/cutting-tool.png b/docs/assets/cutting-tool.png new file mode 100644 index 0000000000..c4fc8ea0a0 Binary files /dev/null and b/docs/assets/cutting-tool.png differ diff --git a/docs/assets/destruction-core.png b/docs/assets/destruction-core.png new file mode 100644 index 0000000000..35955255c4 Binary files /dev/null and b/docs/assets/destruction-core.png differ diff --git a/docs/assets/destructor.png b/docs/assets/destructor.png new file mode 100644 index 0000000000..b20e63855a Binary files /dev/null and b/docs/assets/destructor.png differ diff --git a/docs/assets/detector.png b/docs/assets/detector.png new file mode 100644 index 0000000000..956146fda6 Binary files /dev/null and b/docs/assets/detector.png differ diff --git a/docs/assets/disk-drive.png b/docs/assets/disk-drive.png new file mode 100644 index 0000000000..01564b76ef Binary files /dev/null and b/docs/assets/disk-drive.png differ diff --git a/docs/assets/disk-manipulator.png b/docs/assets/disk-manipulator.png new file mode 100644 index 0000000000..4f9762e95f Binary files /dev/null and b/docs/assets/disk-manipulator.png differ diff --git a/docs/assets/exporter.png b/docs/assets/exporter.png new file mode 100644 index 0000000000..1ddde1203c Binary files /dev/null and b/docs/assets/exporter.png differ diff --git a/docs/assets/external-storage.png b/docs/assets/external-storage.png new file mode 100644 index 0000000000..6d8b58b77d Binary files /dev/null and b/docs/assets/external-storage.png differ diff --git a/docs/assets/filter.png b/docs/assets/filter.png new file mode 100644 index 0000000000..4bb83a3311 Binary files /dev/null and b/docs/assets/filter.png differ diff --git a/docs/assets/fluid-grid.png b/docs/assets/fluid-grid.png new file mode 100644 index 0000000000..57b2aec2a4 Binary files /dev/null and b/docs/assets/fluid-grid.png differ diff --git a/docs/assets/fluid-interface.png b/docs/assets/fluid-interface.png new file mode 100644 index 0000000000..679c14d590 Binary files /dev/null and b/docs/assets/fluid-interface.png differ diff --git a/docs/assets/fortune-upgrade.png b/docs/assets/fortune-upgrade.png new file mode 100644 index 0000000000..ec815023fc Binary files /dev/null and b/docs/assets/fortune-upgrade.png differ diff --git a/docs/assets/grid.png b/docs/assets/grid.png new file mode 100644 index 0000000000..88ccf10c2f Binary files /dev/null and b/docs/assets/grid.png differ diff --git a/docs/assets/hollow-cover.png b/docs/assets/hollow-cover.png new file mode 100644 index 0000000000..725a7aad9b Binary files /dev/null and b/docs/assets/hollow-cover.png differ diff --git a/docs/assets/importer.png b/docs/assets/importer.png new file mode 100644 index 0000000000..82fccf72fd Binary files /dev/null and b/docs/assets/importer.png differ diff --git a/docs/assets/improved-processor.png b/docs/assets/improved-processor.png new file mode 100644 index 0000000000..dcdbf464cc Binary files /dev/null and b/docs/assets/improved-processor.png differ diff --git a/docs/assets/interdimensional-upgrade.png b/docs/assets/interdimensional-upgrade.png new file mode 100644 index 0000000000..194c7953d6 Binary files /dev/null and b/docs/assets/interdimensional-upgrade.png differ diff --git a/docs/assets/interface.png b/docs/assets/interface.png new file mode 100644 index 0000000000..fa42e5b2c3 Binary files /dev/null and b/docs/assets/interface.png differ diff --git a/docs/assets/machine-casing.png b/docs/assets/machine-casing.png new file mode 100644 index 0000000000..c426283a54 Binary files /dev/null and b/docs/assets/machine-casing.png differ diff --git a/docs/assets/network-card.png b/docs/assets/network-card.png new file mode 100644 index 0000000000..fece38405e Binary files /dev/null and b/docs/assets/network-card.png differ diff --git a/docs/assets/network-receiver.png b/docs/assets/network-receiver.png new file mode 100644 index 0000000000..abe97acc14 Binary files /dev/null and b/docs/assets/network-receiver.png differ diff --git a/docs/assets/network-transmitter.png b/docs/assets/network-transmitter.png new file mode 100644 index 0000000000..81591fdde0 Binary files /dev/null and b/docs/assets/network-transmitter.png differ diff --git a/docs/assets/pattern-grid.png b/docs/assets/pattern-grid.png new file mode 100644 index 0000000000..62a48fe431 Binary files /dev/null and b/docs/assets/pattern-grid.png differ diff --git a/docs/assets/pattern.png b/docs/assets/pattern.png new file mode 100644 index 0000000000..33bb9b5f64 Binary files /dev/null and b/docs/assets/pattern.png differ diff --git a/docs/assets/portable-grid.png b/docs/assets/portable-grid.png new file mode 100644 index 0000000000..6cf68e1c99 Binary files /dev/null and b/docs/assets/portable-grid.png differ diff --git a/docs/assets/processing-pattern-encoder.png b/docs/assets/processing-pattern-encoder.png new file mode 100644 index 0000000000..f44718324c Binary files /dev/null and b/docs/assets/processing-pattern-encoder.png differ diff --git a/docs/assets/processor-binding.png b/docs/assets/processor-binding.png new file mode 100644 index 0000000000..1e4c0c1711 Binary files /dev/null and b/docs/assets/processor-binding.png differ diff --git a/docs/assets/quartz-enriched-iron.png b/docs/assets/quartz-enriched-iron.png new file mode 100644 index 0000000000..08504636b1 Binary files /dev/null and b/docs/assets/quartz-enriched-iron.png differ diff --git a/docs/assets/range-upgrade.png b/docs/assets/range-upgrade.png new file mode 100644 index 0000000000..c4fffbac4f Binary files /dev/null and b/docs/assets/range-upgrade.png differ diff --git a/docs/assets/raw-advanced-processor.png b/docs/assets/raw-advanced-processor.png new file mode 100644 index 0000000000..734360f735 Binary files /dev/null and b/docs/assets/raw-advanced-processor.png differ diff --git a/docs/assets/raw-basic-processor.png b/docs/assets/raw-basic-processor.png new file mode 100644 index 0000000000..8113a4e20f Binary files /dev/null and b/docs/assets/raw-basic-processor.png differ diff --git a/docs/assets/raw-improved-processor.png b/docs/assets/raw-improved-processor.png new file mode 100644 index 0000000000..d6c23cc429 Binary files /dev/null and b/docs/assets/raw-improved-processor.png differ diff --git a/docs/assets/reader.png b/docs/assets/reader.png new file mode 100644 index 0000000000..3d408f8fb0 Binary files /dev/null and b/docs/assets/reader.png differ diff --git a/docs/assets/regulator-upgrade.png b/docs/assets/regulator-upgrade.png new file mode 100644 index 0000000000..d14472391d Binary files /dev/null and b/docs/assets/regulator-upgrade.png differ diff --git a/docs/assets/relay.png b/docs/assets/relay.png new file mode 100644 index 0000000000..d7ceecb6f2 Binary files /dev/null and b/docs/assets/relay.png differ diff --git a/docs/assets/security-card.png b/docs/assets/security-card.png new file mode 100644 index 0000000000..f16d91c34c Binary files /dev/null and b/docs/assets/security-card.png differ diff --git a/docs/assets/security-manager.png b/docs/assets/security-manager.png new file mode 100644 index 0000000000..2c733473df Binary files /dev/null and b/docs/assets/security-manager.png differ diff --git a/docs/assets/silicon.png b/docs/assets/silicon.png new file mode 100644 index 0000000000..1233aa5019 Binary files /dev/null and b/docs/assets/silicon.png differ diff --git a/docs/assets/silk-touch-upgrade.png b/docs/assets/silk-touch-upgrade.png new file mode 100644 index 0000000000..cc25227384 Binary files /dev/null and b/docs/assets/silk-touch-upgrade.png differ diff --git a/docs/assets/solderer.png b/docs/assets/solderer.png new file mode 100644 index 0000000000..e2332df293 Binary files /dev/null and b/docs/assets/solderer.png differ diff --git a/docs/assets/speed-upgrade.png b/docs/assets/speed-upgrade.png new file mode 100644 index 0000000000..4c05ea2ff3 Binary files /dev/null and b/docs/assets/speed-upgrade.png differ diff --git a/docs/assets/stack-upgrade.png b/docs/assets/stack-upgrade.png new file mode 100644 index 0000000000..00c427364e Binary files /dev/null and b/docs/assets/stack-upgrade.png differ diff --git a/docs/assets/storage-housing.png b/docs/assets/storage-housing.png new file mode 100644 index 0000000000..1f6446dd56 Binary files /dev/null and b/docs/assets/storage-housing.png differ diff --git a/docs/assets/storage-monitor.png b/docs/assets/storage-monitor.png new file mode 100644 index 0000000000..1c2373dc72 Binary files /dev/null and b/docs/assets/storage-monitor.png differ diff --git a/docs/assets/upgrade.png b/docs/assets/upgrade.png new file mode 100644 index 0000000000..489c689d4e Binary files /dev/null and b/docs/assets/upgrade.png differ diff --git a/docs/assets/wireless-crafting-monitor.png b/docs/assets/wireless-crafting-monitor.png new file mode 100644 index 0000000000..aec7aa6769 Binary files /dev/null and b/docs/assets/wireless-crafting-monitor.png differ diff --git a/docs/assets/wireless-fluid-grid.png b/docs/assets/wireless-fluid-grid.png new file mode 100644 index 0000000000..9d8fc29f2e Binary files /dev/null and b/docs/assets/wireless-fluid-grid.png differ diff --git a/docs/assets/wireless-grid.png b/docs/assets/wireless-grid.png new file mode 100644 index 0000000000..81aa1dc30e Binary files /dev/null and b/docs/assets/wireless-grid.png differ diff --git a/docs/assets/wireless-transmitter.png b/docs/assets/wireless-transmitter.png new file mode 100644 index 0000000000..637e5f76f8 Binary files /dev/null and b/docs/assets/wireless-transmitter.png differ diff --git a/docs/assets/wrench.png b/docs/assets/wrench.png new file mode 100644 index 0000000000..fb200ba194 Binary files /dev/null and b/docs/assets/wrench.png differ diff --git a/docs/assets/writer.png b/docs/assets/writer.png new file mode 100644 index 0000000000..0018f6cf0e Binary files /dev/null and b/docs/assets/writer.png differ diff --git a/docs/component.json b/docs/component.json new file mode 100644 index 0000000000..2413ba8022 --- /dev/null +++ b/docs/component.json @@ -0,0 +1,9 @@ +{ + "name": "Refined Storage", + "version": "0.0.0", + "pagesPath": "pages/", + "pageTemplateOverrides": { + "index.adoc": "refined-storage-index" + }, + "assetsPath": "assets/" +} \ No newline at end of file diff --git a/docs/nav.json b/docs/nav.json new file mode 100644 index 0000000000..ab8b133b7b --- /dev/null +++ b/docs/nav.json @@ -0,0 +1,427 @@ +[ + { + "title": "Home", + "ref": "index.adoc", + "icon": "bi-house-fill" + }, + { + "title": "What's new", + "ref": "whats-new.adoc", + "icon": "bi-lightbulb-fill" + }, + { + "title": "Getting started", + "ref": "getting-started.adoc", + "icon": "bi-book" + }, + { + "title": "FAQ", + "ref": "faq.adoc", + "icon": "bi-question-circle-fill" + }, + { + "title": "Networking", + "ref": "networking/index.adoc", + "children": [ + { + "ref": "networking/controller.adoc" + }, + { + "ref": "networking/creative-controller.adoc" + }, + { + "ref": "networking/cable.adoc" + }, + { + "ref": "networking/detector.adoc" + }, + { + "ref": "networking/relay.adoc" + } + ] + }, + { + "title": "Storage", + "ref": "storage/index.adoc", + "children": [ + { + "ref": "storage/storing-externally.adoc" + }, + { + "ref": "storage/storing-fluids.adoc" + }, + { + "ref": "storage/disk-drive.adoc" + }, + { + "ref": "storage/external-storage.adoc" + }, + { + "ref": "storage/1k-storage-part.adoc" + }, + { + "ref": "storage/4k-storage-part.adoc" + }, + { + "ref": "storage/16k-storage-part.adoc" + }, + { + "ref": "storage/64k-storage-part.adoc" + }, + { + "ref": "storage/storage-housing.adoc" + }, + { + "ref": "storage/1k-storage-disk.adoc" + }, + { + "ref": "storage/4k-storage-disk.adoc" + }, + { + "ref": "storage/16k-storage-disk.adoc" + }, + { + "ref": "storage/64k-storage-disk.adoc" + }, + { + "ref": "storage/creative-storage-disk.adoc" + }, + { + "ref": "storage/1k-storage-block.adoc" + }, + { + "ref": "storage/4k-storage-block.adoc" + }, + { + "ref": "storage/16k-storage-block.adoc" + }, + { + "ref": "storage/64k-storage-block.adoc" + }, + { + "ref": "storage/creative-storage-block.adoc" + }, + { + "ref": "storage/64k-fluid-storage-part.adoc" + }, + { + "ref": "storage/256k-fluid-storage-part.adoc" + }, + { + "ref": "storage/1024k-fluid-storage-part.adoc" + }, + { + "ref": "storage/4096k-fluid-storage-part.adoc" + }, + { + "ref": "storage/64k-fluid-storage-disk.adoc" + }, + { + "ref": "storage/256k-fluid-storage-disk.adoc" + }, + { + "ref": "storage/1024k-fluid-storage-disk.adoc" + }, + { + "ref": "storage/4096k-fluid-storage-disk.adoc" + }, + { + "ref": "storage/creative-fluid-storage-disk.adoc" + }, + { + "ref": "storage/64k-fluid-storage-block.adoc" + }, + { + "ref": "storage/256k-fluid-storage-block.adoc" + }, + { + "ref": "storage/1024k-fluid-storage-block.adoc" + }, + { + "ref": "storage/4096k-fluid-storage-block.adoc" + }, + { + "ref": "storage/creative-fluid-storage-block.adoc" + } + ] + }, + { + "title": "Viewing resources", + "ref": "viewing-resources/index.adoc", + "children": [ + { + "ref": "viewing-resources/how-to-view-resources.adoc" + }, + { + "ref": "viewing-resources/grid.adoc" + }, + { + "ref": "viewing-resources/crafting-grid.adoc" + }, + { + "ref": "viewing-resources/fluid-grid.adoc" + }, + { + "ref": "viewing-resources/storage-monitor.adoc" + }, + { + "ref": "viewing-resources/portable-grid.adoc" + } + ] + }, + { + "title": "Input and output", + "ref": "input-and-output/index.adoc", + "children": [ + { + "ref": "input-and-output/getting-items-in-and-out.adoc" + }, + { + "ref": "input-and-output/importer.adoc" + }, + { + "ref": "input-and-output/exporter.adoc" + }, + { + "ref": "input-and-output/constructor.adoc" + }, + { + "ref": "input-and-output/destructor.adoc" + }, + { + "ref": "input-and-output/interface.adoc" + }, + { + "ref": "input-and-output/fluid-interface.adoc" + }, + { + "ref": "input-and-output/disk-manipulator.adoc" + }, + { + "ref": "input-and-output/reader.adoc" + }, + { + "ref": "input-and-output/writer.adoc" + } + ] + }, + { + "title": "Wireless networking", + "ref": "wireless-networking/index.adoc", + "children": [ + { + "ref": "wireless-networking/networks-over-long-distances.adoc" + }, + { + "ref": "wireless-networking/wireless-transmitter.adoc" + }, + { + "ref": "wireless-networking/wireless-grid.adoc" + }, + { + "ref": "wireless-networking/creative-wireless-grid.adoc" + }, + { + "ref": "wireless-networking/wireless-fluid-grid.adoc" + }, + { + "ref": "wireless-networking/creative-wireless-fluid-grid.adoc" + }, + { + "ref": "wireless-networking/wireless-crafting-monitor.adoc" + }, + { + "ref": "wireless-networking/creative-wireless-crafting-monitor.adoc" + }, + { + "ref": "wireless-networking/network-card.adoc" + }, + { + "ref": "wireless-networking/network-receiver.adoc" + }, + { + "ref": "wireless-networking/network-transmitter.adoc" + } + ] + }, + { + "title": "Autocrafting", + "ref": "autocrafting/index.adoc", + "children": [ + { + "ref": "autocrafting/getting-started-with-autocrafting.adoc" + }, + { + "ref": "autocrafting/processing-recipes.adoc" + }, + { + "ref": "autocrafting/keeping-items-in-stock.adoc" + }, + { + "ref": "autocrafting/fluid-autocrafting.adoc" + }, + { + "ref": "autocrafting/keeping-fluids-in-stock.adoc" + }, + { + "ref": "autocrafting/autocrafting-with-filled-buckets.adoc" + }, + { + "ref": "autocrafting/locking-and-unlocking.adoc" + }, + { + "ref": "autocrafting/pattern-grid.adoc" + }, + { + "ref": "autocrafting/pattern.adoc" + }, + { + "ref": "autocrafting/crafter.adoc" + }, + { + "ref": "autocrafting/crafting-monitor.adoc" + }, + { + "ref": "autocrafting/crafter-manager.adoc" + }, + { + "ref": "autocrafting/processing-pattern-encoder.adoc" + } + ] + }, + { + "title": "Security", + "ref": "security/index.adoc", + "children": [ + { + "ref": "security/security-manager.adoc" + }, + { + "ref": "security/security-card.adoc" + } + ] + }, + { + "title": "Upgrades", + "ref": "upgrades/index.adoc", + "children": [ + { + "ref": "upgrades/upgrade.adoc" + }, + { + "ref": "upgrades/range-upgrade.adoc" + }, + { + "ref": "upgrades/speed-upgrade.adoc" + }, + { + "ref": "upgrades/stack-upgrade.adoc" + }, + { + "ref": "upgrades/crafting-upgrade.adoc" + }, + { + "ref": "upgrades/regulator-upgrade.adoc" + }, + { + "ref": "upgrades/fortune-upgrade.adoc" + }, + { + "ref": "upgrades/silk-touch-upgrade.adoc" + }, + { + "ref": "upgrades/interdimensional-upgrade.adoc" + } + ] + }, + { + "title": "Utility", + "ref": "utility/index.adoc", + "children": [ + { + "ref": "utility/quartz-enriched-iron.adoc" + }, + { + "ref": "utility/block-of-quartz-enriched-iron.adoc" + }, + { + "ref": "utility/silicon.adoc" + }, + { + "ref": "utility/cut-silicon.adoc" + }, + { + "ref": "utility/wrench.adoc" + }, + { + "ref": "utility/cutting-tool.adoc" + }, + { + "ref": "utility/filter.adoc" + }, + { + "ref": "utility/processor-binding.adoc" + }, + { + "ref": "utility/raw-basic-processor.adoc" + }, + { + "ref": "utility/raw-improved-processor.adoc" + }, + { + "ref": "utility/raw-advanced-processor.adoc" + }, + { + "ref": "utility/basic-processor.adoc" + }, + { + "ref": "utility/improved-processor.adoc" + }, + { + "ref": "utility/advanced-processor.adoc" + }, + { + "ref": "utility/construction-core.adoc" + }, + { + "ref": "utility/destruction-core.adoc" + }, + { + "ref": "utility/machine-casing.adoc" + }, + { + "ref": "utility/solderer.adoc" + }, + { + "ref": "utility/cover.adoc" + }, + { + "ref": "utility/hollow-cover.adoc" + } + ] + }, + { + "title": "Advanced usage", + "ref": "advanced-usage/index.adoc", + "children": [ + { + "ref": "advanced-usage/commands.adoc" + }, + { + "ref": "advanced-usage/profiling.adoc" + }, + { + "ref": "advanced-usage/resource-packs.adoc" + }, + { + "ref": "advanced-usage/translating-refined-storage.adoc" + }, + { + "ref": "advanced-usage/using-development-builds.adoc" + }, + { + "ref": "advanced-usage/using-the-api.adoc" + } + ] + } +] \ No newline at end of file diff --git a/docs/pages/advanced-usage/commands.adoc b/docs/pages/advanced-usage/commands.adoc new file mode 100644 index 0000000000..f97486ceb8 --- /dev/null +++ b/docs/pages/advanced-usage/commands.adoc @@ -0,0 +1,76 @@ += Commands + +[cols="1,1"] +|=== +|Refined Storage version|Command |Explanation + +|v1.9.5 or higher |`/refinedstorage disk create `|Creates a disk for a player by disk ID. +|v1.9.5 or higher |`/refinedstorage disk list`|Lists all disks on the server. +|v1.9.5 or higher |`/refinedstorage disk list `|Lists all disks on the server, that the given player created. +|v1.9.5 or higher |`/refinedstorage network list `|Lists all networks in a dimension, sorted by highest tick time first. +|v1.9.5 or higher |`/refinedstorage network get `|Gets information about a network in a dimension and position. +|v1.9.5 or higher |`/refinedstorage network get autocrafting list`|Gets all autocrafting tasks for a network. +|v1.9.5 or higher |`/refinedstorage network get autocrafting get `|Gets a specific autocrafting task in a network. +|v1.9.5 or higher |`/refinedstorage network get autocrafting cancel`|Cancels all autocrafting tasks in a network. +|v1.9.5 or higher |`/refinedstorage network get autocrafting cancel `|Cancels a specific autocrafting task in a network. +|v1.9.5 or higher |`/refinedstorage pattern dump`|Dumps information about the currently held xref:../autocrafting/pattern.adoc[]. Meant for debugging purposes. +|v1.6.x |`/createdisk`|See <<_createdisk>>. +|=== + +[#_createdisk] +== `/createdisk` + +[.alert.alert-info] +**** +This command is only available for Minecraft 1.12.2 on Refined Storage version v1.6.x. +**** + +Use the `/createdisk` command to spawn in a disk with a given ID. + +=== Usage + +`/createdisk ` + +==== Player + +The player name to give the disk to. + +==== Item + +The item ID of the storage disk. +For Refined Storage this would be `refinedstorage:storage_disk` (or `refinedstorage:fluid_storage_disk` for fluid disks). + +==== Metadata + +The metadata value signifies the type of disk. + +**Items** + +[cols="1,1"] +|=== +|Disk type|Metadata value + +|1k|0 +|4k|1 +|16k|2 +|64k|3 +|Creative|4 +|=== + +**Fluids** + +[cols="1,1"] +|=== +|Disk type|Metadata value + +|64k|0 +|256k|1 +|1024k|2 +|4096k|3 +|Creative|4 +|=== + +==== ID + +The ID parameter is the ID of the disk. +A disk ID can be found by turning on advanced tooltips and checking the tooltip of the disk. \ No newline at end of file diff --git a/docs/pages/advanced-usage/index.adoc b/docs/pages/advanced-usage/index.adoc new file mode 100644 index 0000000000..f2c60e41b8 --- /dev/null +++ b/docs/pages/advanced-usage/index.adoc @@ -0,0 +1,8 @@ += Advanced usage + +- xref:commands.adoc[] +- xref:profiling.adoc[] +- xref:resource-packs.adoc[] +- xref:translating-refined-storage.adoc[] +- xref:using-development-builds.adoc[] +- xref:using-the-api.adoc[] diff --git a/docs/pages/advanced-usage/profiling.adoc b/docs/pages/advanced-usage/profiling.adoc new file mode 100644 index 0000000000..83872e1fae --- /dev/null +++ b/docs/pages/advanced-usage/profiling.adoc @@ -0,0 +1,33 @@ += Profiling + +If you have a performance, it's best to make a `.nps` file that you can send to the developers so that they can investigate further. + +== Installing Sampler + +Sampler is a mod by Player that generates .nps files. +You can download it from link:https://forum.industrial-craft.net/thread/10820[here]. + +=== For Minecraft 1.12 + +link:http://files.player.to/sampler-1.73.jar[http://files.player.to/sampler-1.73.jar] + +=== For Minecraft 1.11 + +link:http://files.player.to/sampler-1.72.1.jar[http://files.player.to/sampler-1.72.1.jar] + +=== For Minecraft 1.10 + +link:http://files.player.to/sampler-1.69.3.jar[http://files.player.to/sampler-1.69.3.jar] + +== Running Sampler + +Then you can `/sampler start` and `/sampler stop` while it's lagging. + +Then a simple `/sampler export [name of exported nps file here]` will write out the .nps file that can be read by the developers in VisualVM. + +== Where to run Sampler? + +- Is it a performance on the server, like tick lag? +Run Sampler *on the server*, NOT on your client! +- Is it a performance on the client, like FPS lag? +Run Sampler *on the client*, NOT on your server! diff --git a/docs/pages/advanced-usage/resource-packs.adoc b/docs/pages/advanced-usage/resource-packs.adoc new file mode 100644 index 0000000000..ddd9e8cfd0 --- /dev/null +++ b/docs/pages/advanced-usage/resource-packs.adoc @@ -0,0 +1,25 @@ += Resource packs + +== Color settings + +You can change the text colors that Refined Storage uses in its GUIs by changing the `pack.mcmeta` file. + +Example: + +[source,json] +---- +{ + "pack": { + "pack_format": 4, + "description": "An example" + }, + "refinedstorage": { + "primary_color": 11184810, + "secondary_color": 11184810 + } +} +---- + +`primary_color` is used for the GUI titles, `secondary_color` is used for all the rest. + +The color is an integer representation of an RGBA color. \ No newline at end of file diff --git a/docs/pages/advanced-usage/translating-refined-storage.adoc b/docs/pages/advanced-usage/translating-refined-storage.adoc new file mode 100644 index 0000000000..33debabfae --- /dev/null +++ b/docs/pages/advanced-usage/translating-refined-storage.adoc @@ -0,0 +1,16 @@ += Translating Refined Storage + +== How to create a translation + +Copy link:https://github.com/refinedmods/refinedstorage/blob/develop/src/main/resources/assets/refinedstorage/lang/en_us.json[en_us.json] from Refined Storage GitHub repository to a text file on your computer and replace the texts with your language. + +== How to submit your translation + +* If you know Git well enough, you can contribute new language files via a pull request. +* If you do not know how to use Git/GitHub, upload the translation file to Pastebin or Gist and send it to me through a link:https://github.com/refinedmods/refinedstorage/issues[GitHub issue]. + +== Updating existing translations + +You can compare the new and removed translation keys yourself, link:https://github.com/refinedmods/refinedstorage/blob/develop/tools/missing-translation-keys.sh[or use a Bash script] that outputs a diff between `en_US` and the version specified. + +You can, of course, always diff manually using another tool, like the `diff` utility or an online diffing tool. diff --git a/docs/pages/advanced-usage/using-development-builds.adoc b/docs/pages/advanced-usage/using-development-builds.adoc new file mode 100644 index 0000000000..4673958a14 --- /dev/null +++ b/docs/pages/advanced-usage/using-development-builds.adoc @@ -0,0 +1,15 @@ += Using development builds + +You can use development builds straight from GitHub. + +Follow the following steps: + +- Head to the link:https://github.com/refinedmods/refinedstorage/actions/workflows/build.yml[list of builds]. +- Click on the commit that you want a build of. +- Download "Artifacts". + +== Disclaimer + +- Using development builds is a risk! +- It may contain untested code, bugs and crashes. +- Remember to take backups. \ No newline at end of file diff --git a/docs/pages/advanced-usage/using-the-api.adoc b/docs/pages/advanced-usage/using-the-api.adoc new file mode 100644 index 0000000000..f43e5ae1ed --- /dev/null +++ b/docs/pages/advanced-usage/using-the-api.adoc @@ -0,0 +1,85 @@ += Using the API + +== For Minecraft 1.18.2 or later + +Starting from Minecraft 1.18, you can include the Refined Storage API in your development environment from 2 sources: + +=== GitHub packages + +Add the following repository to your `build.gradle`: + +[source,groovy] +---- +repositories { + maven { + url = uri("https://maven.pkg.github.com/refinedmods/refinedstorage") + credentials { + username = "anything" + password = "\u0067hp_oGjcDFCn8jeTzIj4Ke9pLoEVtpnZMP4VQgaX" + } + } +} +---- + +The credentials are necessary because as of December 2021, GitHub packages still requires authentication for public packages. +The password used is a personal access token that has read access to the Refined Mods repositories. +It can be reused in other projects. + +See: + +* https://github.community/t/download-from-github-package-registry-without-authentication/14407/38 +* https://github.community/t/download-from-github-package-registry-without-authentication/14407/44 + +You can find a list of versions on link:https://github.com/orgs/refinedmods/packages[GitHub packages]. + +=== CreeperHost Maven + +Add the following repository to your `build.gradle`: + +[source,groovy] +---- +repositories { + maven { + url = uri("https://maven.creeperhost.net") + } +} +---- + +You can find a list of versions on the link:https://maven.creeperhost.net/com/refinedmods/refinedstorage[Maven index]. + +**Warning:** Due to a bug in the Maven index on CreeperHost, new versions aren't included in the index. +However, you can use them in your Gradle dependency. + +For example, version `1.10.2` isn't included in the Maven index, but you can use `1.10.2` in your Gradle dependency when using CreeperHost Maven. + +== For older Minecraft versions + +Some Refined Storage API versions for older Minecraft versions are available on the link:https://maven.creeperhost.net/com/refinedmods/refinedstorage[CreeperHost Maven]. + +However, not all of them are available. +If you need a specific version, build Refined Storage yourself and include the API manually. + +== Including the API + +[source,groovy] +---- +implementation fg.deobf("com.refinedmods:refinedstorage:VERSION_HERE") { + transitive false +} +---- + +== Using the API + +Use the `@RSAPIInject` annotation to get access to the API facade. + +[source,java] +---- +public class MyMod { + @RSAPIInject + public static IRSAPI RSAPI; +} +---- + +== Javadoc + +Updated Javadoc is available after every release link:https://refinedmods.com/javadoc/refinedstorage[here]. diff --git a/docs/pages/autocrafting/autocrafting-with-filled-buckets.adoc b/docs/pages/autocrafting/autocrafting-with-filled-buckets.adoc new file mode 100644 index 0000000000..9eec2f9fb2 --- /dev/null +++ b/docs/pages/autocrafting/autocrafting-with-filled-buckets.adoc @@ -0,0 +1,15 @@ += Autocrafting with filled buckets + +Some crafting recipes may require a filled fluid bucket. +To use fluids from your fluid storage to fill buckets, you can set up a xref:pattern.adoc#_processing[processing pattern] that has following inputs: + +- 1 empty bucket +- 1000 mB of the fluid of your choice + +For the output: + +- 1 filled bucket + +Put that in a xref:crafter.adoc[] that faces a bucket filling machine (link:https://teamcofh.com/docs/thermal-expansion/fluid-transposer/[that for example Thermal Expansion has]). +Refined Storage will output the fluid from your fluid storage, and, an empty bucket. +It is up to the external machine to fill it. \ No newline at end of file diff --git a/docs/pages/autocrafting/crafter-manager.adoc b/docs/pages/autocrafting/crafter-manager.adoc new file mode 100644 index 0000000000..caf2299cc5 --- /dev/null +++ b/docs/pages/autocrafting/crafter-manager.adoc @@ -0,0 +1,32 @@ += Crafter Manager +:icon: crafter-manager.png +:from: v1.5.33 + +The Crafter Manager is a block that allows you to see all your xref:pattern.adoc[patterns] in one GUI. + +== Naming + +All the xref:pattern.adoc[patterns] are listed and categorized per xref:crafter.adoc[]. +The categorization is based on the name of the xref:crafter.adoc[]. + +To decide which name a xref:crafter.adoc[] gets, the following rules (in order) are used: + +1. If the xref:crafter.adoc[] is renamed with a Minecraft link:https://minecraft.gamepedia.com/Anvil[Anvil], use that name +2. If the xref:crafter.adoc[] is connected to a machine in the world, use the name of that machine +3. Use "Crafter" as name + +== Sizes + +One can configure the Crafter Manager size: + +- Stretched (default) +- Small +- Medium +- Large + +When choosing the stretched size, the Crafter Manager will take up all the vertical screen space. +This can be limited through the `maxRowsStretch` config option. + +include::../../partials/search-box.adoc[] + +include::../../partials/recoloring.adoc[] \ No newline at end of file diff --git a/docs/pages/autocrafting/crafter.adoc b/docs/pages/autocrafting/crafter.adoc new file mode 100644 index 0000000000..93b9327b2b --- /dev/null +++ b/docs/pages/autocrafting/crafter.adoc @@ -0,0 +1,37 @@ += Crafter +:icon: crafter.png +:from: v0.6.0-alpha + +The {doctitle} is a block that crafts items with xref:pattern.adoc[patterns]. +It can take xref:../upgrades/speed-upgrade.adoc[speed upgrades] to increase the crafting speed. + +With processing xref:pattern.adoc[patterns], the {doctitle} has to face the correct input side of the machine. + +[#_chaining] +== Chaining + +A {doctitle} can be chained by letting them face each other. + +This is useful when connecting a {doctitle} to a single machine. +When you run out of slots in your first {doctitle}, the one facing the machine, you can put another {doctitle} behind the first {doctitle} to get additional xref:pattern.adoc[] slots. + +== {doctitle} modes + +The {doctitle} has 4 modes: + +- Ignore redstone signal (default) +- Redstone signal unlocks autocrafting +- Redstone signal locks autocrafting +- Redstone pulse inserts next set + +The (un)locking mechanism is used to block the {doctitle}, so it can't insert items or fluids into the connected inventory. + +"Blocking mode" can be achieved with the "Redstone pulse inserts next set" mode. + +See xref:locking-and-unlocking.adoc[] for more details. + +include::../../partials/recoloring.adoc[] + +== Applicable upgrades + +- xref:../upgrades/speed-upgrade.adoc[] \ No newline at end of file diff --git a/docs/pages/autocrafting/crafting-monitor.adoc b/docs/pages/autocrafting/crafting-monitor.adoc new file mode 100644 index 0000000000..681b1a3da4 --- /dev/null +++ b/docs/pages/autocrafting/crafting-monitor.adoc @@ -0,0 +1,31 @@ += Crafting Monitor +:icon: crafting-monitor.png +:from: v0.6.0-alpha + +The {doctitle} is a block that shows all the current running crafting tasks and how long they have been running. + +Each crafting task can be cancelled manually. +It is also possible to cancel all crafting tasks at once. + +Per task, it shows a grid of cells, each containing information about how an item or fluid is used in the crafting task. +This is what the terminology in those cells mean: + +- Stored: the item or fluid is stored in the internal inventory of the crafting task, and will be used later on +- Missing: the crafting task cannot continue without this item or fluid as it's missing +- Processing: the item or fluid displayed is currently inserted into an external machine and is processing +- Scheduled: the item or fluid is scheduled to be made by inserting it's ingredients in an external machine later +- Crafting: this item is being crafted (regular crafting, not processing) + +== 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. + +include::../../partials/recoloring.adoc[] diff --git a/docs/pages/autocrafting/fluid-autocrafting.adoc b/docs/pages/autocrafting/fluid-autocrafting.adoc new file mode 100644 index 0000000000..834114ef31 --- /dev/null +++ b/docs/pages/autocrafting/fluid-autocrafting.adoc @@ -0,0 +1,27 @@ += Fluid autocrafting + +So far you've set up autocrafting for items. +Since Refined Storage has support for xref:../storage/storing-fluids.adoc[storing fluids] as well, it speaks for itself that Refined Storage can also autocraft with fluids. + +Every autocrafting pattern that uses fluids is a processing pattern. +If you forgot, a processing pattern is a xref:pattern.adoc[] that outputs items to an external inventory and expects an output back, as declared in the xref:pattern.adoc[]. + +With fluid autocrafting, you get the ability to make the xref:crafter.adoc[] output fluids (or items), and when the "result" fluid (or item) is back in the storage network, Refined Storage will detect the task and mark it as finished. + +This means that you can also declare fluids as an output in the processing pattern. +It also means that you can request fluids from the xref:../viewing-resources/fluid-grid.adoc[]. + +You can mix fluid and item inputs/outputs freely. + +== Creation of the mixed pattern + +To make a mixed (fluid or item) processing pattern, toggle the xref:pattern-grid.adoc[] in fluid or item mode. + +You can then use link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)] transfer to transfer item and fluid ingredients. +You can also use a filled fluid container (like a bucket) to specify the fluid. + +Use left or right click on the fluid slot to modify the millibuckets (mB). + +== Other resources + +- link:https://www.youtube.com/watch?v=6v-e_NdLEnI[Demo video] \ No newline at end of file diff --git a/docs/pages/autocrafting/getting-started-with-autocrafting.adoc b/docs/pages/autocrafting/getting-started-with-autocrafting.adoc new file mode 100644 index 0000000000..d00233e4bd --- /dev/null +++ b/docs/pages/autocrafting/getting-started-with-autocrafting.adoc @@ -0,0 +1,87 @@ += Getting started with autocrafting + +== What is autocrafting? + +Autocrafting is automated crafting through Refined Storage. + +You can already craft items manually using items from your storage network with the xref:../viewing-resources/crafting-grid.adoc[], but autocrafting makes it a tad bit easier and automated. + +Instead of manually moving items in the crafting matrix, you can make Refined Storage do all the work. + +== Patterns + +To teach Refined Storage a recipe to craft we use a xref:pattern-grid.adoc[]. +This xref:pattern-grid.adoc[] creates xref:pattern.adoc[patterns]. + +A xref:pattern.adoc[] contains the recipe of the item you want to craft. + +== Pattern dependencies + +You need to create a xref:pattern.adoc[] for each sub-item you want automatically crafted. + +Refined Storage will first try to extract the sub-item from your storage, but if it isn't available, it will fall back to the xref:pattern.adoc[] of the sub-item to know how to create it. +If there is no xref:pattern.adoc[] for the sub-item, the sub-item will be displayed as "missing" and the autocrafting task can't run. + +== Example + +You want to autocraft link:https://minecraft.gamepedia.com/Chest[chests]. + +- Create a xref:pattern.adoc[] for the chest +- Create a xref:pattern.adoc[] for the wooden planks that are used to craft the chest +- If you don't create the pattern, and you have wooden planks, than Refined Storage will be able to use those +- If you run out of planks, Refined Storage will not know what to do +- If you don't create the pattern, and you don't have wooden planks, than Refined Storage will not know how to craft this item and the crafting task can't + +== Exact mode + +Exact mode is turned on by default which means every xref:pattern.adoc[] is an "exact pattern". +This means Refined Storage takes items exactly as defined in the xref:pattern.adoc[] + +When Exact mode is turned off it will also match for other acceptable inputs for that crafting recipe (other types of wood, etc). + +== Crafters + +Once you created your xref:pattern.adoc[patterns], craft a xref:crafter.adoc[] and connect it to your storage network. + +In those xref:crafter.adoc[crafters] you'll store all your xref:pattern.adoc[patterns]. + +== Requesting an item + +As soon as the relevant xref:pattern.adoc[patterns] to craft an item are stored in a xref:crafter.adoc[], you will be able to request the item through any xref:../viewing-resources/grid.adoc[]. + +You can do this by clicking on the item you want to autocraft. +If the item is already available and you want to request more of that item, you can use the CTRL + SHIFT key combination to open the crafting window. + +When requesting an item, Refined Storage will first ask how many of that item you want to craft. +Then, it will show you what items it will take or craft. + +You can't start an autocrafting task if you have insufficient resources, unless you have the ability to autocraft those resources. + +== How autocrafting works internally + +Initially, when the autocrafting task is started, all the "initial" needed items and fluids are extracted from the storage network and inserted into the internal storage of the autocrafting task (crafting storage). + +All further actions to those items are performed in the internal storage, so the network doesn't "see" any changes while the task is running. + +Because all the subcrafts are done in the internal storage, the storage network can not "steal" items from autocrafting tasks. + +When an item is inserted through an xref:../input-and-output/importer.adoc[] or xref:../input-and-output/interface.adoc[], it will first go through the internal storage of autocrafting. +That is prioritized. +If the autocrafting task deems the item or fluid as necessary, it will be intercepted and the storage network will receive nothing. + +== Monitoring your crafting tasks + +Craft a xref:crafting-monitor.adoc[] and connect it to your storage network to see how the crafting task is progressing. + +You can also cancel autocrafting tasks from there. + +You can also use a xref:../wireless-networking/wireless-crafting-monitor.adoc[] to see the running crafting tasks remotely from your inventory. + +== Managing your patterns in a convenient way + +Want a convenient way to access all your xref:pattern.adoc[patterns] in the xref:crafter.adoc[crafters] of your storage network? +Use the xref:crafter-manager.adoc[]. + +== Speeding up your crafting tasks + +Insert xref:../upgrades/speed-upgrade.adoc[speed upgrades] in the xref:crafter.adoc[crafters]. \ No newline at end of file diff --git a/docs/pages/autocrafting/index.adoc b/docs/pages/autocrafting/index.adoc new file mode 100644 index 0000000000..c801c5b4e1 --- /dev/null +++ b/docs/pages/autocrafting/index.adoc @@ -0,0 +1,15 @@ += Autocrafting + +- xref:getting-started-with-autocrafting.adoc[] +- xref:processing-recipes.adoc[] +- xref:keeping-items-in-stock.adoc[] +- xref:fluid-autocrafting.adoc[] +- xref:keeping-fluids-in-stock.adoc[] +- xref:autocrafting-with-filled-buckets.adoc[] +- xref:locking-and-unlocking.adoc[] +- xref:pattern-grid.adoc[] +- xref:pattern.adoc[] +- xref:crafter.adoc[] +- xref:crafting-monitor.adoc[] +- xref:crafter-manager.adoc[] +- xref:processing-pattern-encoder.adoc[] diff --git a/docs/pages/autocrafting/keeping-fluids-in-stock.adoc b/docs/pages/autocrafting/keeping-fluids-in-stock.adoc new file mode 100644 index 0000000000..1c870b5a7b --- /dev/null +++ b/docs/pages/autocrafting/keeping-fluids-in-stock.adoc @@ -0,0 +1,14 @@ += Keeping fluids in stock + +Keeping fluids in stock work the same way as xref:keeping-items-in-stock.adoc[keeping items in stock]. + +Create a xref:../input-and-output/fluid-interface.adoc[] with a xref:../upgrades/crafting-upgrade.adoc[] in it. +Then, specify the fluid that you want to keep in stock by clicking a fluid container (like a bucket) in the "out" slot. +You can change the amount by left or right clicking on the fluid. +The fluids will now be autocrafted if needed. + +To make the stocked fluids available to your storage network, create an xref:../storage/external-storage.adoc[] and put it on the xref:../input-and-output/fluid-interface.adoc[]. +Put the xref:../storage/external-storage.adoc[] in fluid mode. + +Make sure the xref:../storage/external-storage.adoc[] is in "extract-only" mode. +That way, Refined Storage won't attempt to insert fluids in the xref:../input-and-output/fluid-interface.adoc[] that is meant for keeping in stock. diff --git a/docs/pages/autocrafting/keeping-items-in-stock.adoc b/docs/pages/autocrafting/keeping-items-in-stock.adoc new file mode 100644 index 0000000000..07772b9c21 --- /dev/null +++ b/docs/pages/autocrafting/keeping-items-in-stock.adoc @@ -0,0 +1,10 @@ += Keeping items in stock + +Create an xref:../input-and-output/interface.adoc[] with a xref:../upgrades/crafting-upgrade.adoc[] in it. +Then, specify the items that you want to keep in stock. +The items will now be autocrafted if needed. + +To make the stocked items available to your storage network, create an xref:../storage/external-storage.adoc[] and put it on the xref:../input-and-output/interface.adoc[]. + +Make sure the xref:../storage/external-storage.adoc[] is in "extract-only" mode. +That way, Refined Storage won't attempt to insert items in the xref:../input-and-output/interface.adoc[] that is meant for keeping in stock. diff --git a/docs/pages/autocrafting/locking-and-unlocking.adoc b/docs/pages/autocrafting/locking-and-unlocking.adoc new file mode 100644 index 0000000000..4e612344e3 --- /dev/null +++ b/docs/pages/autocrafting/locking-and-unlocking.adoc @@ -0,0 +1,68 @@ += Locking and unlocking +:from: v1.6.6 + +The xref:crafter.adoc[] in Refined Storage supports locking mechanisms. + +Locking and unlocking a xref:crafter.adoc[] only applies to processing recipes. + +The locking and unlocking functionality also has to be enabled by configuring the xref:crafter.adoc[] mode. + +== Crafter modes + +=== Ignore redstone signal (default) + +Ignores redstone signals. +This is the default. + +=== Redstone signal locks autocrafting + +- If a xref:crafter.adoc[] is locked, it can't insert items or fluids to the connected inventory. +- If a xref:crafter.adoc[] is unlocked, it can insert items or fluids to the connected inventory. + +=== Redstone signal unlocks autocrafting + +This is the opposite of the "Redstone signal locks autocrafting" mode. + +=== Redstone pulse inserts next set + +This mode was primarily introduced to support a concept called "blocking mode". + +Blocking mode is primarily utilised for processing recipes, where the machine that does the processing can only handle 1 recipe at a time. + +If the xref:crafter.adoc[] is in "Redstone pulse inserts next set" mode, this is the flow: + +- The xref:crafter.adoc[] will automatically go in an unlocked state +- As soon as you request a recipe in this xref:crafter.adoc[], it will send out 1 set of items and fluids defined in the xref:pattern.adoc[] +- The xref:crafter.adoc[] now goes in a locked state, and it won't push out any more items and fluids +- The xref:crafter.adoc[] will stay locked until it receives a redstone pulse + +When you apply a redstone pulse: + +- The xref:crafter.adoc[] will unlock itself +- The xref:crafter.adoc[] pushes the next set of items and fluids, if any +- If there were any items and fluids to push, the xref:crafter.adoc[] will lock itself again + +Generally, you'd apply a redstone signal if the recipe you're processing has completed. +It is up to the player to handle that. + +== Common mistakes with "Redstone pulse inserts next set" + +- Wrong redstone flow causes the xref:crafter.adoc[] to lock when it is supposed to unlock +- When testing your contraption, accidentally locking the xref:crafter.adoc[] and then wondering why your xref:crafter.adoc[] doesn't process anything next time you request something + +=== Crafter deadlock + +If you use an xref:../input-and-output/importer.adoc[] on a chest to import the final processed item, and also using a comparator to send the redstone signal to the xref:crafter.adoc[] to unlock again: + +- If the xref:../input-and-output/importer.adoc[] imports too fast AND +- the comparator doesn't pick up the item being in the chest AND +- by not picking up the item, thus, not sending out a redstone signal + +You'd cause a deadlock because the xref:crafter.adoc[] doesn't receive a redstone pulse, and the xref:crafter.adoc[] would keep waiting forever. + +The solution for this is to only enable the xref:../input-and-output/importer.adoc[] AFTER the redstone pulse is sent to the xref:crafter.adoc[]. +Use the xref:../input-and-output/importer.adoc[] redstone settings to achieve this. + +== Other resources + +- link:https://www.youtube.com/watch?v=c9s-IfDPKxw[Demo video] \ No newline at end of file diff --git a/docs/pages/autocrafting/pattern-grid.adoc b/docs/pages/autocrafting/pattern-grid.adoc new file mode 100644 index 0000000000..79e30803b5 --- /dev/null +++ b/docs/pages/autocrafting/pattern-grid.adoc @@ -0,0 +1,51 @@ += Pattern Grid +:icon: pattern-grid.png +:from: v0.6.0-alpha + +The {doctitle} is the same as a regular xref:../viewing-resources/grid.adoc[], but also allows for the creation of xref:pattern.adoc[patterns]. + +== Mode + +By default, the {doctitle} creates regular crafting xref:pattern.adoc[patterns]. + +To create processing xref:pattern.adoc[patterns], toggle the "processing" checkbox. + +== Allowed tags + +The allowed tags system in Refined Storage allows the player to decide which items or fluids can be used as alternatives when the specified item or fluid isn't found in the storage network. + +These tags are retrieved from link:https://minecraft.gamepedia.com/Tag[Minecraft's tag system]. +You can specify the allowed tags in the {doctitle}. + +To define valid alternatives for an item or fluid, use CTRL + click on the input slot and specify the allowed tags that can be used during autocrafting. +Items or fluids from that tag are then marked as valid alternatives if the original item or fluid can't be found in the storage network. + +You can also define valid alternatives by clicking on the item or fluid and then clicking on "Alternatives". + +== Ore dictionary (Refined Storage v1.6.x or lower only) + +To create ore dictionary sensitive xref:pattern.adoc[patterns], toggle the "oredict" checkbox. + +== Modifying a pattern + +You can re-insert a xref:pattern.adoc[] in the output slot to modify and (possibly) override it. + +== Recipe transferring + +The {doctitle} integrates with link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)] so the player can use recipe transferring. + +You don't necessarily need the actual items in your storage network to create a xref:pattern.adoc[] for it. + +Refined Storage will notify you when you have a xref:pattern.adoc[] for an item configured when transferring a recipe. + +== Manual input/output configuration + +Click an item or fluid in the slots to configure the xref:pattern.adoc[]. + +Click on the item or fluid to change the quantity. + +Use CTRL + click to modify the allowed tags for the input slot (Minecraft 1.14.4 and above). + +Use shift to clear the slot. + +include::../../partials/recoloring.adoc[] \ No newline at end of file diff --git a/docs/pages/autocrafting/pattern.adoc b/docs/pages/autocrafting/pattern.adoc new file mode 100644 index 0000000000..54537dea8e --- /dev/null +++ b/docs/pages/autocrafting/pattern.adoc @@ -0,0 +1,44 @@ += Pattern +:icon: pattern.png +:from: v0.6.0-alpha + +A {doctitle} is an item that is used in autocrafting. +It stores the recipe that should be autocrafted. + +A recipe can be assigned with the xref:pattern-grid.adoc[] and the {doctitle} is stored in a xref:crafter.adoc[]. + +[#_processing] +== Processing + +If the {doctitle} is in processing mode, it will push the inputs to the connected inventory of the xref:crafter.adoc[]. + +== Exact mode (patterns in crafting mode) + +Exact mode is turned on by default which means every {doctitle} is an "exact pattern". +This means Refined Storage takes items exactly as defined in the {doctitle}. + +When Exact mode is turned off it will also match for other acceptable inputs for that crafting recipe. + +Exact mode can't be set for patterns in processing mode. +For processing mode, see the section about allowed tags. + +== Allowed tags (patterns in processing mode) + +The allowed tags system in Refined Storage allows the player to decide which items or fluids can be used as alternatives when the original specified item or fluid isn't found in the storage network. + +These tags are retrieved from link:https://minecraft.gamepedia.com/Tag[Minecraft's tag system]. +You can specify the allowed tags in the xref:pattern-grid.adoc[]. + +== Ore dictionary mode (Refined Storage v1.6.x or lower only) + +The {doctitle} can be configured to be an ore dictionary pattern. +Instead of extracting the exact item, it'll try to extract equivalent items according to the ore dictionary as well. + +== Clearing + +Use SHIFT + right click in your inventory while holding the {doctitle} to clear it. +You can also override the {doctitle} in the xref:pattern-grid.adoc[]. + +== Modifying + +You can re-insert a {doctitle} in the output slot of the xref:pattern-grid.adoc[] to modify and (possibly) override it. \ No newline at end of file diff --git a/docs/pages/autocrafting/processing-pattern-encoder.adoc b/docs/pages/autocrafting/processing-pattern-encoder.adoc new file mode 100644 index 0000000000..715feec00b --- /dev/null +++ b/docs/pages/autocrafting/processing-pattern-encoder.adoc @@ -0,0 +1,21 @@ += Processing Pattern Encoder +:icon: processing-pattern-encoder.png +:from: v0.6.0-alpha +:to: v1.5.6 + +[.alert.alert-warning] +**** +The {doctitle} has been removed in v1.5.6 and its functionality has been moved to the xref:pattern-grid.adoc[]. +**** + +A {doctitle} is used to create xref:pattern.adoc[patterns] meant for machine automation. + +It takes up to 9 inputs and 9 outputs, so the storage network knows what to take and what to expect. + +This block can't be connected to a storage network. + +== Recipe transferring + +The {doctitle} integrates with link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)] so the player can use recipe transferring. + +When using this, Refined Storage will use the inputs and outputs that the link:https://minecraft.curseforge.com/projects/jei[JEI] recipe has. \ No newline at end of file diff --git a/docs/pages/autocrafting/processing-recipes.adoc b/docs/pages/autocrafting/processing-recipes.adoc new file mode 100644 index 0000000000..c6a3db99bf --- /dev/null +++ b/docs/pages/autocrafting/processing-recipes.adoc @@ -0,0 +1,47 @@ += Processing recipes + +== What are processing recipes? + +So far, in xref:getting-started-with-autocrafting.adoc[] you learnt how to automate regular crafting recipes. + +What if you want to automate the creation of items that don't involve a crafting recipe, like ores to ingots in a furnace? + +For this you use processing xref:pattern.adoc[patterns]. + +== Processing patterns + +You can create processing xref:pattern.adoc[patterns] in the xref:pattern-grid.adoc[] by toggling the "processing" checkbox. + +The GUI will change and it'll allow you to define up to 9 inputs and outputs. + +- Inputs is what Refined Storage will extract from your storage network. +- Outputs are what Refined Storage expects back in the network when the item has processed. + +== Example + +Let's say you want to automate link:https://minecraft.gamepedia.com/Iron_Ore[Iron Ore] to link:https://minecraft.gamepedia.com/Iron_Ingot[Iron Ingot]. + +- In the input section you put 1 link:https://minecraft.gamepedia.com/Iron_Ore[Iron Ore]. +- In the output section you put 1 link:https://minecraft.gamepedia.com/Iron_Ingot[Iron Ingot]. + +== Inserting the pattern + +Make a xref:crafter.adoc[] and let it face the machine in a way it can input it in the correct slot. + +Insert the processing xref:pattern.adoc[] you just created in the xref:crafter.adoc[] facing the machine. + +When you now request the item, Refined Storage will insert the inputs in the machine. + +You do need to get the item manually back in the storage network so Refined Storage knows that the item has been processed. +You can use any device to get the item back in the storage network, like an xref:../input-and-output/interface.adoc[] or xref:../input-and-output/importer.adoc[]. + +== Allowed tags + +The allowed tags system in Refined Storage allows the player to decide which items or fluids can be used as alternatives when the original specified item or fluid isn't found in the storage network. + +These tags are retrieved from Minecraft's tag system. +You can specify the allowed tags in the xref:pattern-grid.adoc[]. + +== Chaining crafters + +You can xref:crafter.adoc#_chaining[chain crafters] to connect multiple xref:crafter.adoc[crafters] to the same machine. \ No newline at end of file diff --git a/docs/pages/faq.adoc b/docs/pages/faq.adoc new file mode 100644 index 0000000000..5937187b2e --- /dev/null +++ b/docs/pages/faq.adoc @@ -0,0 +1,68 @@ += Frequently asked questions (FAQ) + +== I have an idea for a feature that can be toggled on or off with an config option! + +Refined Storage doesn't do config options for features or things that change behavior in general. +Why not? + +- The experience players have with Refined Storage can differ between modpacks and that can be confusing +- Issues will be created by players wondering why their favorite feature doesn't work in modpack A, but does in modpack B +- Putting features or behaviors behind a config option makes it harder to maintain +- With bug reports we'd have to ask if the feature is toggled on or off in the config +- Bugs might get noticed later since it's behind a config option and thus less visible + +== Not including "X" in Refined Storage makes this mod useless when mods like "Y" aren't installed! + +The philosophy of the mod is to have as less overlap with other mods and to only focus on the storage network part of the mod. +If other mods are required to achieve something, that isn't a problem. + +Examples: + +- Autocrafting needs an external bucket filling machine in order to convert fluids to buckets +- Energy that Refined Storage uses needs to be generated with another mod + +== What is the difference between Refined Storage and Applied Energistics? + +Refined Storage is the simpler of the two and was heavily based off of AE1. + +AE2 has been around for years and was a direct descendent of AE1, while RS is much younger and started mostly scratch with AE (both versions) as inspiration. + +A lot of people prefer the simplicity of RS, while a similarly large portion of people prefer AE2's complexity due to enjoying the puzzle aspects. + +== Can I use this mod in my private/public mod pack? + +Yes, you don't need to ask permission. + +== Can I connect Refined Storage to my Applied Energistics 2 system, or vice-versa? + +No, you can't. + +You might've found an issue on our issue tracker that says you can, but no, you can't. + +== Is there a Refined Storage for MC 1.7.10? + +No, there isn't. + +== Will you make a Refined Storage for MC 1.7.10? + +No, I won't. + +== What versions of Minecraft are supported? + +See xref:whats-new.adoc#_version_support[version support]. + +== Is there a way to have infinite Wireless Transmitter range? + +It's not possible if you're using the base Refined Storage mod, or Refined Storage Addons. +You'll have to find an addon mod which does add such functionality. + +Alternatively, you can increase the range in the Refined Storage config file to be infinite. + +== Is there a way to request autocrafting in the Grid if I already have the item or fluid? + +Yes! +There are many helpful key and mouse bindings for the xref:viewing-resources/grid.adoc#_controls[grid]. + +== I found an issue/bug with Refined Storage! + +Head over to our link:https://github.com/refinedmods/refinedstorage/issues[issue tracker on GitHub] and report it there. \ No newline at end of file diff --git a/docs/pages/getting-started.adoc b/docs/pages/getting-started.adoc new file mode 100644 index 0000000000..fd4db9bdd3 --- /dev/null +++ b/docs/pages/getting-started.adoc @@ -0,0 +1,55 @@ += Getting started + +== Core concepts + +Refined Storage is a storage mod where you can build a storage network made up of devices. +Those devices manipulate your storage. + +In this tutorial: + +- You'll craft a xref:storage/disk-drive.adoc[]. +A xref:storage/disk-drive.adoc[] can contain item or fluid storage disks. +Those disks will provide your storage network with storage. +If you insert or extract an item, it will use the data on your disks. +- You'll craft a xref:viewing-resources/grid.adoc[]. +Through that block, you can modify your storage (which will modify the data on your disks). +- Before crafting any of these devices, you'll first craft a xref:networking/controller.adoc[], which ties the entire network together. + +== A minimal setup + +=== Step 0: Install Refined Storage (if necessary) + +Ensure that the modpack that you are playing contains Refined Storage. +You can validate this by checking the modlist of your modpack. + +If your modpack doesn't have Refined Storage installed, or you are creating your own modpack, xref:how-to-install.adoc[check the installation instructions here]. + +It might also be helpful to know that Refined Storage xref:how-to-install.adoc#_optional_dependencies[has integration with various other mods]. + +=== Step 1: The Controller + +Craft the xref:networking/controller.adoc[]. +The xref:networking/controller.adoc[] is the "core" of your storage network. +You'll be connecting all the Refined Storage devices to this block. + +The xref:networking/controller.adoc[] needs energy. +More specifically, Forge Energy or RF. +Lots of mods that generate energy support this. + +=== Step 2: Storage and accessing your items + +Craft a xref:storage/disk-drive.adoc[] and a xref:storage/1k-storage-disk.adoc[] to store your items. + +You can craft a higher tier of xref:storage/index.adoc#_storage_disks[storage disk], but for simplicity sake we're going for a 1k, which can store 1.000 items. + +Put the xref:storage/1k-storage-disk.adoc[] in the xref:storage/disk-drive.adoc[] and craft a xref:viewing-resources/grid.adoc[] to access your items. + +Connect those blocks to the xref:networking/controller.adoc[] with xref:networking/cable.adoc[], but you can also just place them next to each other in any direction. + +=== Step 3: Viewing your storage + +You are now able to insert and extract items in the xref:viewing-resources/grid.adoc[]. + +== Disks in block form + +You can also use the various xref:storage/index.adoc#_storage_blocks[storage blocks] instead of xref:storage/index.adoc#_storage_disks[storage disks]. \ No newline at end of file diff --git a/docs/pages/how-to-install.adoc b/docs/pages/how-to-install.adoc new file mode 100644 index 0000000000..7b5e93beae --- /dev/null +++ b/docs/pages/how-to-install.adoc @@ -0,0 +1,54 @@ += How to install + +Installing Refined Storage is the same as for any other Forge mod. + +== Setting up Forge + +You'll need a working Forge instance to use Refined Storage. +You can use launchers like MultiMC or even the vanilla launcher to do this. + +Instructions for setting up a Forge instance are plenty online and are out of scope for this wiki. + +== Downloading the mod + +Download a Refined Storage `.jar` file for your Minecraft version from official sources: + +- link:https://www.curseforge.com/minecraft/mc-mods/refined-storage[CurseForge] +- link:https://modrinth.com/mod/refined-storage[Modrinth] +- link:https://github.com/refinedmods/refinedstorage/releases[GitHub] + +== Installing the mod + +Once you have the `.jar` file, place it in the `mods/` directory of your Forge instance. +You may have to start up your instance at least once so Forge can autogenerate the `mods/` directory. + +== CurseForge/Twitch launcher + +When you're using a launcher like the CurseForge/Twitch launcher, you can install Refined Storage in an instance with one click without having to copy over `.jar` files. + +== Configuring the mod + +Changing the configuration isn't needed in most cases. +If you need to do this, you can: + +- Change server-specific configuration in `saves//serverconfig/refinedstorage-server.toml` +- Change client-specific configuration in `config/refinedstorage-client.toml` + +Note that server-specific configuration also applies to single player worlds. +That is because when you're playing single player, Minecraft uses an internal server. + +[#_optional_dependencies] +== Optional dependencies + +Refined Storage can work perfectly by itself without any additional mods, but it's helpful to install a few other mods alongside it. + +- **link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)]:** This mod will help you view the recipes of the various items and blocks in the mod. +- **A mod that can generate Forge Energy (also known as FE or RF):** A Refined Storage network requires energy to run. +If you do not want to generate energy, you can disable energy usage in the Refined Storage server-side config (see section above "Configuring the mod"). +Change `useEnergy` under `[controller]` to `false`. +- **link:https://www.curseforge.com/minecraft/mc-mods/crafting-tweaks[Crafting Tweaks]** +- **link:https://www.curseforge.com/minecraft/mc-mods/curios[Curios]** +- **link:https://www.curseforge.com/minecraft/mc-mods/inventory-sorter[Inventory Sorter]** + +Until Minecraft 1.14, xref:opencomputers-api.adoc[Refined Storage had integration with OpenComputers]. + diff --git a/docs/pages/index.adoc b/docs/pages/index.adoc new file mode 100644 index 0000000000..9c11996529 --- /dev/null +++ b/docs/pages/index.adoc @@ -0,0 +1,8 @@ += Refined Storage + +[.p-5.mb-4.bg-body-tertiary.rounded-3] +== Refined Storage is a mass storage mod for Minecraft that offers the player a network-based storage system, allowing them to store items and fluids on a massively expandable device network. +''' +Items and fluids can be stored in one of the many storage capabilities that the mod offers. Any storage devices connected to the same network are accessible to the player through one simple Grid interface, allowing the player to access the inventories of many devices through a single unified GUI. + +This mod not only adds storage solutions, but also devices that can be used to manipulate items and blocks in the world and from within the system, such as importers, exporters, constructors, destructors, and more! There are also devices in this mod that allow the player to setup auto-crafting, allowing the crafting of complex recipes in a few simple clicks. diff --git a/docs/pages/input-and-output/constructor.adoc b/docs/pages/input-and-output/constructor.adoc new file mode 100644 index 0000000000..f922d3da16 --- /dev/null +++ b/docs/pages/input-and-output/constructor.adoc @@ -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[] diff --git a/docs/pages/input-and-output/destructor.adoc b/docs/pages/input-and-output/destructor.adoc new file mode 100644 index 0000000000..a1c33bf759 --- /dev/null +++ b/docs/pages/input-and-output/destructor.adoc @@ -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[] diff --git a/docs/pages/input-and-output/disk-manipulator.adoc b/docs/pages/input-and-output/disk-manipulator.adoc new file mode 100644 index 0000000000..a1f190bc24 --- /dev/null +++ b/docs/pages/input-and-output/disk-manipulator.adoc @@ -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[] \ No newline at end of file diff --git a/docs/pages/input-and-output/exporter.adoc b/docs/pages/input-and-output/exporter.adoc new file mode 100644 index 0000000000..5e6ad8b065 --- /dev/null +++ b/docs/pages/input-and-output/exporter.adoc @@ -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[] diff --git a/docs/pages/input-and-output/fluid-interface.adoc b/docs/pages/input-and-output/fluid-interface.adoc new file mode 100644 index 0000000000..da4eb2e0aa --- /dev/null +++ b/docs/pages/input-and-output/fluid-interface.adoc @@ -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[] \ No newline at end of file diff --git a/docs/pages/input-and-output/getting-items-in-and-out.adoc b/docs/pages/input-and-output/getting-items-in-and-out.adoc new file mode 100644 index 0000000000..700bcae3fb --- /dev/null +++ b/docs/pages/input-and-output/getting-items-in-and-out.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/input-and-output/importer.adoc b/docs/pages/input-and-output/importer.adoc new file mode 100644 index 0000000000..ce31a4a2cf --- /dev/null +++ b/docs/pages/input-and-output/importer.adoc @@ -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[] \ No newline at end of file diff --git a/docs/pages/input-and-output/index.adoc b/docs/pages/input-and-output/index.adoc new file mode 100644 index 0000000000..82fcdf4484 --- /dev/null +++ b/docs/pages/input-and-output/index.adoc @@ -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[] \ No newline at end of file diff --git a/docs/pages/input-and-output/interface.adoc b/docs/pages/input-and-output/interface.adoc new file mode 100644 index 0000000000..a2128c741b --- /dev/null +++ b/docs/pages/input-and-output/interface.adoc @@ -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[] \ No newline at end of file diff --git a/docs/pages/input-and-output/reader.adoc b/docs/pages/input-and-output/reader.adoc new file mode 100644 index 0000000000..8fd388216a --- /dev/null +++ b/docs/pages/input-and-output/reader.adoc @@ -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 \ No newline at end of file diff --git a/docs/pages/input-and-output/writer.adoc b/docs/pages/input-and-output/writer.adoc new file mode 100644 index 0000000000..7956818625 --- /dev/null +++ b/docs/pages/input-and-output/writer.adoc @@ -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 \ No newline at end of file diff --git a/docs/pages/networking/cable.adoc b/docs/pages/networking/cable.adoc new file mode 100644 index 0000000000..1276ca06a0 --- /dev/null +++ b/docs/pages/networking/cable.adoc @@ -0,0 +1,7 @@ += Cable +:from: v0.3.0-alpha +:icon: cable.png + +{doctitle} is used to connect devices to the xref:controller.adoc[]. + +They are not always necessary, as long as the devices are next to each other in any direction a connection will be established as well. diff --git a/docs/pages/networking/controller.adoc b/docs/pages/networking/controller.adoc new file mode 100644 index 0000000000..88f3a4efa7 --- /dev/null +++ b/docs/pages/networking/controller.adoc @@ -0,0 +1,37 @@ += Controller +:from: v0.3.0-alpha +:icon: controller.png + +The {doctitle} is the core of the Refined Storage network. +You need to connect all the Refined Storage devices to this block. + +== Connecting devices + +You are supposed to connect every device that depends on the storage network connection to the {doctitle}. + +You can connect devices with xref:cable.adoc[cables]. + +xref:cable.adoc[Cables] are not always necessary, as long as the devices are next to each other in any direction a connection will be established as well. + +== Energy + +The {doctitle} accepts and consumes Forge Energy (FE). +Most mods have a way to generate energy, therefore Refined Storage doesn't come by itself with a way to generate energy. + +- The energy is extracted per tick. +- The amount of energy that is extracted depends on the amount of devices, and which devices. +- Every device type consumes another amount of energy. +- You can see how many energy each device consumes by right clicking the {doctitle}. + +If the {doctitle} runs out of energy, the network will be turned off until there is sufficient energy provided again. + +When the {doctitle} is broken, it will maintain its energy. + +== Limits + +Each Refined Storage network can only have a single {doctitle}. +It doesn't make sense to connect multiple controllers on the same network. + +If you connect another {doctitle} to an already existing network, the {doctitle} will break as an item in the world. + +include::../../partials/recoloring.adoc[] \ No newline at end of file diff --git a/docs/pages/networking/creative-controller.adoc b/docs/pages/networking/creative-controller.adoc new file mode 100644 index 0000000000..87f5014359 --- /dev/null +++ b/docs/pages/networking/creative-controller.adoc @@ -0,0 +1,9 @@ += Creative Controller +:from: v0.3.0-alpha +:icon: controller.png + +The {doctitle} is the same as a regular xref:controller.adoc[] but has infinite energy. + +It can only be obtained in creative mode. + +include::../../partials/recoloring.adoc[] diff --git a/docs/pages/networking/detector.adoc b/docs/pages/networking/detector.adoc new file mode 100644 index 0000000000..e4727f3e43 --- /dev/null +++ b/docs/pages/networking/detector.adoc @@ -0,0 +1,30 @@ += Detector +:icon: detector.png +:from: v0.3.0-alpha + +The {doctitle} is a block that emits a redstone signal if an item, or fluid count matches a given amount. + +It is also possible to be NBT or damage sensitive. + +== Types of criteria + +[cols="1,1"] +|=== +|Criteria|Explanation + +|<|Emits a signal when lower than the given amount +|>|Emits a signal when higher than the given amount +|=|Emits a signal when equal to the given amount +|=== + +== Checking the total count in the storage + +When no item/fluid, is specified, the criteria won't care about the count of a specific item/fluid, but rather the count of all items/fluids, in the storage. + +== Amounts in fluid mode + +When the {doctitle} is in fluid mode, the amount given is in millibuckets (mB). + +If you want to check for 1 bucket of a fluid, use 1000, not 1. + +include::../../partials/recoloring.adoc[] diff --git a/docs/pages/networking/index.adoc b/docs/pages/networking/index.adoc new file mode 100644 index 0000000000..522bd5f321 --- /dev/null +++ b/docs/pages/networking/index.adoc @@ -0,0 +1,7 @@ += Networking + +- xref:controller.adoc[] +- xref:creative-controller.adoc[] +- xref:cable.adoc[] +- xref:detector.adoc[] +- xref:relay.adoc[] \ No newline at end of file diff --git a/docs/pages/networking/relay.adoc b/docs/pages/networking/relay.adoc new file mode 100644 index 0000000000..f5acb50090 --- /dev/null +++ b/docs/pages/networking/relay.adoc @@ -0,0 +1,9 @@ += Relay +:from: v0.4.0-alpha +:icon: relay.png + +The Relay acts as xref:cable.adoc[], but can be turned on or off depending on the redstone configuration. + +Devices connected after the Relay will be on or off depending if the {doctitle} is on. + +include::../../partials/recoloring.adoc[] \ No newline at end of file diff --git a/docs/pages/opencomputers-api.adoc b/docs/pages/opencomputers-api.adoc new file mode 100644 index 0000000000..e24fc66633 --- /dev/null +++ b/docs/pages/opencomputers-api.adoc @@ -0,0 +1,27 @@ += OpenComputers API + +[cols="1,1"] +|=== +|Method|Description| + +|`isConnected():boolean`|Whether the node is connected. +|`getEnergyUsage():number`|Gets the energy usage of this network.| +|`getTasks():table`|Gets the crafting tasks of this network. +|`getPattern(stack:table):table`|Get one pattern of this network. +|`getFluidPattern(stack:table):table`|Get one fluid pattern of this network. +|`getPatterns():table`|Gets the patterns of this network. +|`getFluidPatterns():table`|Gets the fluid patterns of this network. +|`hasPattern(stack:table):boolean`|Whether a crafting pattern exists for this item. +|`hasFluidPattern(stack:table):boolean`|Whether a crafting pattern exists for this fluid. +|`scheduleTask(stack:table[,count: number[, canSchedule: boolean]]):table`|Schedules a crafting task. +|`scheduleFluidTask(stack:table[,count: number[, canSchedule: boolean]]):table`|Schedules a fluid crafting task. +|`cancelTask(stack:table):number`|Cancels a task and returns the amount of tasks cancelled. +|`cancelFluidTask(stack:table):number`|Cancels a fluid task and returns the amount of tasks cancelled. +|`extractFluid(stack:table[,amount:number[, direction:number]]):table`|Extracts a fluid from the network. +|`getFluid(stack:table):table`|Gets a fluid from the network. +|`getFluids():table`|Gets a list of all fluids in this network. +|`extractItem(stack:table[,count:number[, direction:number]]):table`|Extracts an item from the network. +|`getItem(stack:table[,compareMeta:boolean[, compareNBT:boolean]]):table`|Gets an item from the network. +|`getItems():table`|Gets a list of all items in this network. +|`getStorages():table`|Gets a list of all connected storage disks and blocks in this network. +|=== \ No newline at end of file diff --git a/docs/pages/security/index.adoc b/docs/pages/security/index.adoc new file mode 100644 index 0000000000..0c806366e6 --- /dev/null +++ b/docs/pages/security/index.adoc @@ -0,0 +1,4 @@ += Security + +- xref:security-manager.adoc[] +- xref:security-card.adoc[] \ No newline at end of file diff --git a/docs/pages/security/security-card.adoc b/docs/pages/security/security-card.adoc new file mode 100644 index 0000000000..f25237e0a2 --- /dev/null +++ b/docs/pages/security/security-card.adoc @@ -0,0 +1,7 @@ += Security Card +:from: v1.4.0-beta +:icon: security-card.png + +The {doctitle} is an item that is bound to a player by right clicking. + +The {doctitle} has to be inserted into a xref:security-manager.adoc[], and can be configured from there as well. \ No newline at end of file diff --git a/docs/pages/security/security-manager.adoc b/docs/pages/security/security-manager.adoc new file mode 100644 index 0000000000..52d9093993 --- /dev/null +++ b/docs/pages/security/security-manager.adoc @@ -0,0 +1,41 @@ += Security Manager +:from: v1.4.0-beta +:icon: security-manager.png + +The {doctitle} is a block that can store xref:security-card.adoc[security cards]. + +From its GUI, you can configure what permissions each player (that is bound with a xref:security-card.adoc[]) has. + +Once the xref:security-card.adoc[] is inserted in the top slots, the permissions for that player will be restricted to the ones configured. + +== Behavior + +When no xref:security-card.adoc[security cards] are active on the network, everyone has access to all permissions. + +Start inserting xref:security-card.adoc[security cards] to define permissions for players. + +Players who have no configured xref:security-card.adoc[] are still able to do everything in the network (all permissions). + +To configure a "global" set of permissions for all unconfigured players, configure a xref:security-card.adoc[] that isn't bound to a player and insert it in the {doctitle}. + +Operators (OPs) on a server have access to all permissions, overriding all network security. + +== The placer + +The placer of the {doctitle} will always be able to open it's GUI and change the security settings, regardless of permissions. + +== Permissions + +[cols="1,1"] +|=== +|Type|Description + +|Insert|Inserting items to the network +|Extract|Extracting items from the network +|Autocrafting|Starting, cancelling and viewing crafting tasks +|Modify|Opening block GUIs from the network +|Build|Adding or removing devices to or from the network +|Security|Ability to change security options +|=== + +include::../../partials/recoloring.adoc[] diff --git a/docs/pages/storage/1024k-fluid-storage-block.adoc b/docs/pages/storage/1024k-fluid-storage-block.adoc new file mode 100644 index 0000000000..9eaaa3e00a --- /dev/null +++ b/docs/pages/storage/1024k-fluid-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/1024k-fluid-storage-disk.adoc b/docs/pages/storage/1024k-fluid-storage-disk.adoc new file mode 100644 index 0000000000..4b9024e0c9 --- /dev/null +++ b/docs/pages/storage/1024k-fluid-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/1024k-fluid-storage-part.adoc b/docs/pages/storage/1024k-fluid-storage-part.adoc new file mode 100644 index 0000000000..c4ef8b540d --- /dev/null +++ b/docs/pages/storage/1024k-fluid-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/16k-storage-block.adoc b/docs/pages/storage/16k-storage-block.adoc new file mode 100644 index 0000000000..139f9ddf9a --- /dev/null +++ b/docs/pages/storage/16k-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/16k-storage-disk.adoc b/docs/pages/storage/16k-storage-disk.adoc new file mode 100644 index 0000000000..b4117a8d9b --- /dev/null +++ b/docs/pages/storage/16k-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/16k-storage-part.adoc b/docs/pages/storage/16k-storage-part.adoc new file mode 100644 index 0000000000..4b83a4d948 --- /dev/null +++ b/docs/pages/storage/16k-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/1k-storage-block.adoc b/docs/pages/storage/1k-storage-block.adoc new file mode 100644 index 0000000000..d71c5535e1 --- /dev/null +++ b/docs/pages/storage/1k-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/1k-storage-disk.adoc b/docs/pages/storage/1k-storage-disk.adoc new file mode 100644 index 0000000000..0f03eabbb4 --- /dev/null +++ b/docs/pages/storage/1k-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/1k-storage-part.adoc b/docs/pages/storage/1k-storage-part.adoc new file mode 100644 index 0000000000..e0252100c2 --- /dev/null +++ b/docs/pages/storage/1k-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/256k-fluid-storage-block.adoc b/docs/pages/storage/256k-fluid-storage-block.adoc new file mode 100644 index 0000000000..f40b4b316b --- /dev/null +++ b/docs/pages/storage/256k-fluid-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/256k-fluid-storage-disk.adoc b/docs/pages/storage/256k-fluid-storage-disk.adoc new file mode 100644 index 0000000000..4c2d83c6fa --- /dev/null +++ b/docs/pages/storage/256k-fluid-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/256k-fluid-storage-part.adoc b/docs/pages/storage/256k-fluid-storage-part.adoc new file mode 100644 index 0000000000..1c4a447c5c --- /dev/null +++ b/docs/pages/storage/256k-fluid-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/4096k-fluid-storage-block.adoc b/docs/pages/storage/4096k-fluid-storage-block.adoc new file mode 100644 index 0000000000..a1989b8358 --- /dev/null +++ b/docs/pages/storage/4096k-fluid-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/4096k-fluid-storage-disk.adoc b/docs/pages/storage/4096k-fluid-storage-disk.adoc new file mode 100644 index 0000000000..35cdc08a1a --- /dev/null +++ b/docs/pages/storage/4096k-fluid-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/4096k-fluid-storage-part.adoc b/docs/pages/storage/4096k-fluid-storage-part.adoc new file mode 100644 index 0000000000..b953c51153 --- /dev/null +++ b/docs/pages/storage/4096k-fluid-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/4k-storage-block.adoc b/docs/pages/storage/4k-storage-block.adoc new file mode 100644 index 0000000000..d3062b38fd --- /dev/null +++ b/docs/pages/storage/4k-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/4k-storage-disk.adoc b/docs/pages/storage/4k-storage-disk.adoc new file mode 100644 index 0000000000..4798093724 --- /dev/null +++ b/docs/pages/storage/4k-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/4k-storage-part.adoc b/docs/pages/storage/4k-storage-part.adoc new file mode 100644 index 0000000000..a9a64fd786 --- /dev/null +++ b/docs/pages/storage/4k-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/64k-fluid-storage-block.adoc b/docs/pages/storage/64k-fluid-storage-block.adoc new file mode 100644 index 0000000000..cb3673e868 --- /dev/null +++ b/docs/pages/storage/64k-fluid-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/64k-fluid-storage-disk.adoc b/docs/pages/storage/64k-fluid-storage-disk.adoc new file mode 100644 index 0000000000..5f6b67fbb4 --- /dev/null +++ b/docs/pages/storage/64k-fluid-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/64k-fluid-storage-part.adoc b/docs/pages/storage/64k-fluid-storage-part.adoc new file mode 100644 index 0000000000..3f2afb4d1e --- /dev/null +++ b/docs/pages/storage/64k-fluid-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/64k-storage-block.adoc b/docs/pages/storage/64k-storage-block.adoc new file mode 100644 index 0000000000..f274383b05 --- /dev/null +++ b/docs/pages/storage/64k-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/64k-storage-disk.adoc b/docs/pages/storage/64k-storage-disk.adoc new file mode 100644 index 0000000000..38c2c189ea --- /dev/null +++ b/docs/pages/storage/64k-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/64k-storage-part.adoc b/docs/pages/storage/64k-storage-part.adoc new file mode 100644 index 0000000000..7b23999e1e --- /dev/null +++ b/docs/pages/storage/64k-storage-part.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/storage/creative-fluid-storage-block.adoc b/docs/pages/storage/creative-fluid-storage-block.adoc new file mode 100644 index 0000000000..8e634aee1e --- /dev/null +++ b/docs/pages/storage/creative-fluid-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/creative-fluid-storage-disk.adoc b/docs/pages/storage/creative-fluid-storage-disk.adoc new file mode 100644 index 0000000000..756d66aa78 --- /dev/null +++ b/docs/pages/storage/creative-fluid-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/creative-storage-block.adoc b/docs/pages/storage/creative-storage-block.adoc new file mode 100644 index 0000000000..6d128f512c --- /dev/null +++ b/docs/pages/storage/creative-storage-block.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/creative-storage-disk.adoc b/docs/pages/storage/creative-storage-disk.adoc new file mode 100644 index 0000000000..a48a099faf --- /dev/null +++ b/docs/pages/storage/creative-storage-disk.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/disk-drive.adoc b/docs/pages/storage/disk-drive.adoc new file mode 100644 index 0000000000..0b05af56c6 --- /dev/null +++ b/docs/pages/storage/disk-drive.adoc @@ -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 \ No newline at end of file diff --git a/docs/pages/storage/external-storage.adoc b/docs/pages/storage/external-storage.adoc new file mode 100644 index 0000000000..239f29d2d6 --- /dev/null +++ b/docs/pages/storage/external-storage.adoc @@ -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 \ No newline at end of file diff --git a/docs/pages/storage/index.adoc b/docs/pages/storage/index.adoc new file mode 100644 index 0000000000..e679f4240e --- /dev/null +++ b/docs/pages/storage/index.adoc @@ -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[] diff --git a/docs/pages/storage/storage-housing.adoc b/docs/pages/storage/storage-housing.adoc new file mode 100644 index 0000000000..e622eeffa8 --- /dev/null +++ b/docs/pages/storage/storage-housing.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/storing-externally.adoc b/docs/pages/storage/storing-externally.adoc new file mode 100644 index 0000000000..fd7f65fc20 --- /dev/null +++ b/docs/pages/storage/storing-externally.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/storage/storing-fluids.adoc b/docs/pages/storage/storing-fluids.adoc new file mode 100644 index 0000000000..85210e1dce --- /dev/null +++ b/docs/pages/storage/storing-fluids.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/upgrades/crafting-upgrade.adoc b/docs/pages/upgrades/crafting-upgrade.adoc new file mode 100644 index 0000000000..2b2fc4049e --- /dev/null +++ b/docs/pages/upgrades/crafting-upgrade.adoc @@ -0,0 +1,7 @@ += Crafting Upgrade +:icon: crafting-upgrade.png +:from: v0.6.0-alpha + +The {doctitle} will schedule a crafting task when the item being used in a device is needed but not available. + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/fortune-upgrade.adoc b/docs/pages/upgrades/fortune-upgrade.adoc new file mode 100644 index 0000000000..0ec727dbca --- /dev/null +++ b/docs/pages/upgrades/fortune-upgrade.adoc @@ -0,0 +1,13 @@ += Fortune Upgrade +:icon: fortune-upgrade.png +:from: v1.2.0 + +The {doctitle} will make the xref:../input-and-output/destructor.adoc[] use a certain fortune level (depending on which upgrade you have) on the block it is breaking. + +This upgrade has 3 versions: + +- Fortune 1 +- Fortune 2 +- Fortune 3 + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/index.adoc b/docs/pages/upgrades/index.adoc new file mode 100644 index 0000000000..b94990d69c --- /dev/null +++ b/docs/pages/upgrades/index.adoc @@ -0,0 +1,11 @@ += Upgrades + +- xref:upgrade.adoc[] +- xref:range-upgrade.adoc[] +- xref:speed-upgrade.adoc[] +- xref:stack-upgrade.adoc[] +- xref:crafting-upgrade.adoc[] +- xref:regulator-upgrade.adoc[] +- xref:fortune-upgrade.adoc[] +- xref:silk-touch-upgrade.adoc[] +- xref:interdimensional-upgrade.adoc[] diff --git a/docs/pages/upgrades/interdimensional-upgrade.adoc b/docs/pages/upgrades/interdimensional-upgrade.adoc new file mode 100644 index 0000000000..3c4ab954f2 --- /dev/null +++ b/docs/pages/upgrades/interdimensional-upgrade.adoc @@ -0,0 +1,13 @@ += Interdimensional Upgrade +:icon: interdimensional-upgrade.png +:from: v0.8.14-beta +:to: v1.6.10 + +[.alert.alert-warning] +**** +This upgrade has been removed in v1.6.10. The xref:../wireless-networking/network-transmitter.adoc[] is now cross dimensional by default. +**** + +The Interdimensional Upgrade is an upgrade that allows the xref:../wireless-networking/network-transmitter.adoc[] to work cross-dimensionally. + +This upgrade takes a lot of extra FE/t by default (1000 FE/t extra). \ No newline at end of file diff --git a/docs/pages/upgrades/range-upgrade.adoc b/docs/pages/upgrades/range-upgrade.adoc new file mode 100644 index 0000000000..27671768cd --- /dev/null +++ b/docs/pages/upgrades/range-upgrade.adoc @@ -0,0 +1,7 @@ += Range Upgrade +:icon: range-upgrade.png +:from: v0.6.0-alpha + +The {doctitle} increases the range of the xref:../wireless-networking/wireless-transmitter.adoc[]. + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/regulator-upgrade.adoc b/docs/pages/upgrades/regulator-upgrade.adoc new file mode 100644 index 0000000000..f49d5eac02 --- /dev/null +++ b/docs/pages/upgrades/regulator-upgrade.adoc @@ -0,0 +1,13 @@ += Regulator Upgrade +:icon: regulator-upgrade.png +:from: v1.8.3-beta + +The Regulator Upgrade is an upgrade that can be inserted into an xref:../input-and-output/exporter.adoc[] to keep certain items or fluids in stock in the connected inventory. + +It will try to keep the connected inventory stocked by using items or fluids from the storage network. + +As soon as the upgrade is inserted, you can right click on a filtered item or fluid in the xref:../input-and-output/exporter.adoc[] GUI to configure the amount to keep in stock. + +Additionally, the Regulator Upgrade can be combined with a xref:crafting-upgrade.adoc[] to start autocrafting tasks when the stock from the storage network runs out. + +By using this upgrade, the amount of FE/t that this device draws will increase. diff --git a/docs/pages/upgrades/silk-touch-upgrade.adoc b/docs/pages/upgrades/silk-touch-upgrade.adoc new file mode 100644 index 0000000000..08f63b4314 --- /dev/null +++ b/docs/pages/upgrades/silk-touch-upgrade.adoc @@ -0,0 +1,7 @@ += Silk Touch Upgrade +:icon: silk-touch-upgrade.png +:from: v1.2.0 + +The {doctitle} makes the xref:../input-and-output/destructor.adoc[] use Silk Touch on the blocks that it is breaking. + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/speed-upgrade.adoc b/docs/pages/upgrades/speed-upgrade.adoc new file mode 100644 index 0000000000..40daf93af1 --- /dev/null +++ b/docs/pages/upgrades/speed-upgrade.adoc @@ -0,0 +1,7 @@ += Speed Upgrade +:icon: speed-upgrade.png +:from: v0.6.0-alpha + +The {doctitle} will increase the speed of the device that it is being inserted to. + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/stack-upgrade.adoc b/docs/pages/upgrades/stack-upgrade.adoc new file mode 100644 index 0000000000..8c5d45081f --- /dev/null +++ b/docs/pages/upgrades/stack-upgrade.adoc @@ -0,0 +1,9 @@ += Stack Upgrade +:icon: stack-upgrade.png +:from: v0.7.7-beta + +The {doctitle} will improve item or fluid transfer speeds by using a whole stack (64 items) instead of 1 item at a time. + +It can be combined with xref:speed-upgrade.adoc[speed upgrades] to let the device go to the next slot quicker. + +By using this upgrade, the amount of FE/t that this device draws will increase. \ No newline at end of file diff --git a/docs/pages/upgrades/upgrade.adoc b/docs/pages/upgrades/upgrade.adoc new file mode 100644 index 0000000000..d9af0dfa2e --- /dev/null +++ b/docs/pages/upgrades/upgrade.adoc @@ -0,0 +1,5 @@ += Upgrade +:icon: upgrade.png +:from: v0.6.0-alpha + +The {doctitle} is the base item used for xref:index.adoc[every type of upgrade]. \ No newline at end of file diff --git a/docs/pages/utility/advanced-processor.adoc b/docs/pages/utility/advanced-processor.adoc new file mode 100644 index 0000000000..9a3c7fe7bf --- /dev/null +++ b/docs/pages/utility/advanced-processor.adoc @@ -0,0 +1,5 @@ += Advanced Processor +:icon: advanced-processor.png +:from: v0.3.0-alpha + +include::../../partials/processor.adoc[] \ No newline at end of file diff --git a/docs/pages/utility/basic-processor.adoc b/docs/pages/utility/basic-processor.adoc new file mode 100644 index 0000000000..d23bf24006 --- /dev/null +++ b/docs/pages/utility/basic-processor.adoc @@ -0,0 +1,5 @@ += Basic Processor +:icon: basic-processor.png +:from: v0.3.0-alpha + +include::../../partials/processor.adoc[] \ No newline at end of file diff --git a/docs/pages/utility/block-of-quartz-enriched-iron.adoc b/docs/pages/utility/block-of-quartz-enriched-iron.adoc new file mode 100644 index 0000000000..8b0ed520f4 --- /dev/null +++ b/docs/pages/utility/block-of-quartz-enriched-iron.adoc @@ -0,0 +1,5 @@ += Block of Quartz Enriched Iron +:from: v1.4.0-beta +:icon: block-of-quartz-enriched-iron.png + +The {doctitle} is xref:quartz-enriched-iron.adoc[] in block form. \ No newline at end of file diff --git a/docs/pages/utility/construction-core.adoc b/docs/pages/utility/construction-core.adoc new file mode 100644 index 0000000000..b24a6ea7f5 --- /dev/null +++ b/docs/pages/utility/construction-core.adoc @@ -0,0 +1,5 @@ += Construction Core +:from: v0.3.0-alpha +:icon: construction-core.png + +The {doctitle} is used in recipes for devices that turn resources from the storage network into resources in the world. \ No newline at end of file diff --git a/docs/pages/utility/cover.adoc b/docs/pages/utility/cover.adoc new file mode 100644 index 0000000000..30841c6fa1 --- /dev/null +++ b/docs/pages/utility/cover.adoc @@ -0,0 +1,11 @@ += Cover +:icon: cover.png +:from: v1.6.0-alpha + +A {doctitle} is an item used to hide xref:../networking/cable.adoc[cables]. + +You can also hide blocks that have a cable on them, like the xref:../input-and-output/importer.adoc[] or xref:../input-and-output/exporter.adoc[]. + +It will block network connections, xref:../networking/cable.adoc[cables] can't pass through the "hidden" side. + +They can be removed by sneaking and right-clicking them with the xref:wrench.adoc[]. diff --git a/docs/pages/utility/cut-silicon.adoc b/docs/pages/utility/cut-silicon.adoc new file mode 100644 index 0000000000..72e74146db --- /dev/null +++ b/docs/pages/utility/cut-silicon.adoc @@ -0,0 +1,12 @@ += Cut Silicon +:icon: cut-silicon.png +:from: v0.3.0-alpha +:to: v1.6.6 + +[.alert.alert-warning] +**** +{doctitle} has been removed in v1.6.6. It has been replaced with xref:processor-binding.adoc[]. +**** + +{doctitle} is used to craft the various processors. +It is made with a xref:cutting-tool.adoc[]. \ No newline at end of file diff --git a/docs/pages/utility/cutting-tool.adoc b/docs/pages/utility/cutting-tool.adoc new file mode 100644 index 0000000000..128fc6841c --- /dev/null +++ b/docs/pages/utility/cutting-tool.adoc @@ -0,0 +1,12 @@ += Cutting Tool +:icon: cutting-tool.png +:from: v1.6.0 +:to: v1.7.0-alpha + +[.alert.alert-warning] +**** +The Cutting Tool has been removed in v1.7.0-alpha. +Crafting covers now uses an iron nugget instead. +**** + +The Cutting Tool is a tool that is used to craft xref:../utility/cover.adoc[covers]. \ No newline at end of file diff --git a/docs/pages/utility/destruction-core.adoc b/docs/pages/utility/destruction-core.adoc new file mode 100644 index 0000000000..fabab02765 --- /dev/null +++ b/docs/pages/utility/destruction-core.adoc @@ -0,0 +1,5 @@ += Destruction Core +:from: v0.3.0-alpha +:icon: destruction-core.png + +The {doctitle} is used in recipes for devices that turn resources from the world into resources in the storage network. \ No newline at end of file diff --git a/docs/pages/utility/filter.adoc b/docs/pages/utility/filter.adoc new file mode 100644 index 0000000000..5189898f58 --- /dev/null +++ b/docs/pages/utility/filter.adoc @@ -0,0 +1,31 @@ += Filter +:icon: filter.png +:from: v0.8.13-beta + +The {doctitle} is an item that can be used in any xref:../viewing-resources/grid.adoc[]. + +In the {doctitle}'s GUI, which can be opened by pressing right click while holding the filter in hand, the player can specify which items and fluids can be visible. + +== Items and fluids + +The Grid can filter fluids in the xref:../viewing-resources/fluid-grid.adoc[] and items in any other xref:../viewing-resources/grid.adoc[] by toggling between item and fluid mode. + +== {doctitle}ing + +The player can choose to let the filter be damage or damage sensitive. +It is also possible to use a mod filter. + +The {doctitle} can be set in a whitelist or blacklist mode, too. + +== Icon and name + +The player can also configure an icon and name for the {doctitle}. + +In item and fluid mode an icon can be specified. + +As soon as the {doctitle} has an icon specified, it will appear as a tab in the xref:../viewing-resources/grid.adoc[]. +Then, open the tab to see the filtered items or fluids. + +== Clearing + +Use SHIFT + right click in your inventory while holding the {doctitle} to clear it. diff --git a/docs/pages/utility/hollow-cover.adoc b/docs/pages/utility/hollow-cover.adoc new file mode 100644 index 0000000000..bcbc2c091b --- /dev/null +++ b/docs/pages/utility/hollow-cover.adoc @@ -0,0 +1,12 @@ += Hollow Cover +:icon: hollow-cover.png +:from: v1.6.0 + +A {doctitle} is the same as a xref:cover.adoc[] but has a hole so that you can pass xref:../networking/cable.adoc[cables] through it. + +You can also put it on the front of an xref:../input-and-output/importer.adoc[] or xref:../input-and-output/exporter.adoc[] to hide part of the block. + +It will let a network signal through. + +They can be removed by sneaking and right-clicking them with the xref:wrench.adoc[]. + diff --git a/docs/pages/utility/improved-processor.adoc b/docs/pages/utility/improved-processor.adoc new file mode 100644 index 0000000000..4df6500196 --- /dev/null +++ b/docs/pages/utility/improved-processor.adoc @@ -0,0 +1,5 @@ += Improved Processor +:icon: improved-processor.png +:from: v0.3.0-alpha + +include::../../partials/processor.adoc[] \ No newline at end of file diff --git a/docs/pages/utility/index.adoc b/docs/pages/utility/index.adoc new file mode 100644 index 0000000000..6da739a1b0 --- /dev/null +++ b/docs/pages/utility/index.adoc @@ -0,0 +1,34 @@ += Utility + +- xref:quartz-enriched-iron.adoc[] +- xref:block-of-quartz-enriched-iron.adoc[] +- xref:silicon.adoc[] +- xref:cut-silicon.adoc[] +- xref:wrench.adoc[] +- xref:cutting-tool.adoc[] +- xref:filter.adoc[] +- xref:machine-casing.adoc[] +- xref:solderer.adoc[] + +== Raw Processors + +- xref:processor-binding.adoc[] +- xref:raw-basic-processor.adoc[] +- xref:raw-improved-processor.adoc[] +- xref:raw-advanced-processor.adoc[] + +== Processors + +- xref:basic-processor.adoc[] +- xref:improved-processor.adoc[] +- xref:advanced-processor.adoc[] + +== Cores + +- xref:construction-core.adoc[] +- xref:destruction-core.adoc[] + +== Covers + +- xref:cover.adoc[] +- xref:hollow-cover.adoc[] \ No newline at end of file diff --git a/docs/pages/utility/machine-casing.adoc b/docs/pages/utility/machine-casing.adoc new file mode 100644 index 0000000000..795e6b1d23 --- /dev/null +++ b/docs/pages/utility/machine-casing.adoc @@ -0,0 +1,5 @@ += Machine Casing +:icon: machine-casing.png +:from: v0.3.0-alpha + +The {doctitle} is a block that is used to craft the various Refined Storage devices. \ No newline at end of file diff --git a/docs/pages/utility/processor-binding.adoc b/docs/pages/utility/processor-binding.adoc new file mode 100644 index 0000000000..dc16187732 --- /dev/null +++ b/docs/pages/utility/processor-binding.adoc @@ -0,0 +1,5 @@ += Processor Binding +:icon: processor-binding.png +:from: v1.6.6 + +{doctitle} is used to craft the various processors. \ No newline at end of file diff --git a/docs/pages/utility/quartz-enriched-iron.adoc b/docs/pages/utility/quartz-enriched-iron.adoc new file mode 100644 index 0000000000..f4a9e612aa --- /dev/null +++ b/docs/pages/utility/quartz-enriched-iron.adoc @@ -0,0 +1,7 @@ += Quartz Enriched Iron +:icon: quartz-enriched-iron.png +:from: v0.3.0-alpha + +{doctitle} is like the name says, iron enriched with quartz. + +It is used in almost all the recipes in Refined Storage. \ No newline at end of file diff --git a/docs/pages/utility/raw-advanced-processor.adoc b/docs/pages/utility/raw-advanced-processor.adoc new file mode 100644 index 0000000000..e10745fedc --- /dev/null +++ b/docs/pages/utility/raw-advanced-processor.adoc @@ -0,0 +1,5 @@ += Raw Advanced Processor +:icon: raw-advanced-processor.png +:from: v0.3.0-alpha + +The {doctitle} is used to craft a xref:advanced-processor.adoc[]. \ No newline at end of file diff --git a/docs/pages/utility/raw-basic-processor.adoc b/docs/pages/utility/raw-basic-processor.adoc new file mode 100644 index 0000000000..d269085042 --- /dev/null +++ b/docs/pages/utility/raw-basic-processor.adoc @@ -0,0 +1,5 @@ += Raw Basic Processor +:icon: raw-basic-processor.png +:from: v0.3.0-alpha + +The {doctitle} is used to craft a xref:basic-processor.adoc[]. \ No newline at end of file diff --git a/docs/pages/utility/raw-improved-processor.adoc b/docs/pages/utility/raw-improved-processor.adoc new file mode 100644 index 0000000000..555f1728f5 --- /dev/null +++ b/docs/pages/utility/raw-improved-processor.adoc @@ -0,0 +1,5 @@ += Raw Improved Processor +:icon: raw-improved-processor.png +:from: v0.3.0-alpha + +The {doctitle} is used to craft a xref:improved-processor.adoc[]. \ No newline at end of file diff --git a/docs/pages/utility/silicon.adoc b/docs/pages/utility/silicon.adoc new file mode 100644 index 0000000000..382df59203 --- /dev/null +++ b/docs/pages/utility/silicon.adoc @@ -0,0 +1,7 @@ += Silicon +:icon: silicon.png +:since: v0.3.0-alpha + +{doctitle} can be obtained by smelting quartz. + +This item has no use other than being used in crafting recipes. \ No newline at end of file diff --git a/docs/pages/utility/solderer.adoc b/docs/pages/utility/solderer.adoc new file mode 100644 index 0000000000..bb3e8b9635 --- /dev/null +++ b/docs/pages/utility/solderer.adoc @@ -0,0 +1,20 @@ += Solderer +:icon: solderer.png +:from: v0.3.0-alpha +:to: v1.6.0 + +[.alert.alert-warning] +**** +The {doctitle} has been removed in v1.6.0. It has been replaced with xref:processor-binding.adoc[]. +**** + +The {doctitle} is a device that is used to craft several items and blocks. + +The {doctitle} is not sided. +You can insert from any side and it'll automatically put the items in the right slot. + +Use of link:https://minecraft.curseforge.com/projects/jei[JEI (Just Enough Items)] is (highly) recommended to see the recipes of the {doctitle}. + +== Applicable upgrades + +- xref:../upgrades/speed-upgrade.adoc[] \ No newline at end of file diff --git a/docs/pages/utility/wrench.adoc b/docs/pages/utility/wrench.adoc new file mode 100644 index 0000000000..12972ca466 --- /dev/null +++ b/docs/pages/utility/wrench.adoc @@ -0,0 +1,10 @@ += Wrench +:icon: wrench.png +:from: v1.2.0 + +The {doctitle} is a tool that can do two things: + +- Rotate blocks +- Break Refined Storage xref:cover.adoc[covers] + +Simply sneak and right click when using the {doctitle}. \ No newline at end of file diff --git a/docs/pages/viewing-resources/crafting-grid.adoc b/docs/pages/viewing-resources/crafting-grid.adoc new file mode 100644 index 0000000000..e7b2e66aca --- /dev/null +++ b/docs/pages/viewing-resources/crafting-grid.adoc @@ -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[] diff --git a/docs/pages/viewing-resources/fluid-grid.adoc b/docs/pages/viewing-resources/fluid-grid.adoc new file mode 100644 index 0000000000..df522cc828 --- /dev/null +++ b/docs/pages/viewing-resources/fluid-grid.adoc @@ -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[] diff --git a/docs/pages/viewing-resources/grid.adoc b/docs/pages/viewing-resources/grid.adoc new file mode 100644 index 0000000000..1d79302dc5 --- /dev/null +++ b/docs/pages/viewing-resources/grid.adoc @@ -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[] diff --git a/docs/pages/viewing-resources/how-to-view-resources.adoc b/docs/pages/viewing-resources/how-to-view-resources.adoc new file mode 100644 index 0000000000..dbf74e2b59 --- /dev/null +++ b/docs/pages/viewing-resources/how-to-view-resources.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/viewing-resources/index.adoc b/docs/pages/viewing-resources/index.adoc new file mode 100644 index 0000000000..020315621d --- /dev/null +++ b/docs/pages/viewing-resources/index.adoc @@ -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[] diff --git a/docs/pages/viewing-resources/portable-grid.adoc b/docs/pages/viewing-resources/portable-grid.adoc new file mode 100644 index 0000000000..1a1f817a2a --- /dev/null +++ b/docs/pages/viewing-resources/portable-grid.adoc @@ -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 +|=== \ No newline at end of file diff --git a/docs/pages/viewing-resources/storage-monitor.adoc b/docs/pages/viewing-resources/storage-monitor.adoc new file mode 100644 index 0000000000..d359e7eebb --- /dev/null +++ b/docs/pages/viewing-resources/storage-monitor.adoc @@ -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 \ No newline at end of file diff --git a/docs/pages/whats-new.adoc b/docs/pages/whats-new.adoc new file mode 100644 index 0000000000..85d66f5607 --- /dev/null +++ b/docs/pages/whats-new.adoc @@ -0,0 +1,26 @@ += What's New + +[#_version_support] +== Version support + +[cols="1,1,1,1,1"] +|=== +|Minecraft version|Refined Storage version range|State|New features|Bugfixes + +|Minecraft 1.20.x|v1.12.x|Maintained|❌|✔️ +|Minecraft 1.19.x|v1.11.x|Maintained|❌|✔️ +|Minecraft 1.18.x|v1.10.x|Maintained|❌|✔️ +|Minecraft 1.17.x|-|Never available|❌|❌ +|Minecraft 1.16.x|v1.9.x|Unmaintained|❌|❌ +|Minecraft 1.15.x|v1.8.x|Unmaintained|❌|❌ +|Minecraft 1.14.x|v1.7.x |Unmaintained|❌|❌ +|Minecraft 1.13.x|-|Never available|❌|❌ +|Minecraft 1.12.x|v1.5.x - v1.6.x|Unmaintained|❌|❌ +|Minecraft 1.11.x|v1.3.x - v1.4.x|Unmaintained|❌|❌ +|Minecraft 1.10.x|v0.8.x - v1.2.x|Unmaintained|❌|❌ +|Minecraft 1.9.x|v0.3.x - v0.7.x|Unmaintained|❌|❌ +|Minecraft 1.8.x|-|Never available|❌|❌ +|Minecraft 1.7.x|-|Never available|❌|❌ +|=== + +Refined Storage v1.x will not be gaining new features as we are building link:https://github.com/refinedmods/refinedstorage2[Refined Storage 2]. diff --git a/docs/pages/wireless-networking/creative-wireless-crafting-monitor.adoc b/docs/pages/wireless-networking/creative-wireless-crafting-monitor.adoc new file mode 100644 index 0000000000..438819fc68 --- /dev/null +++ b/docs/pages/wireless-networking/creative-wireless-crafting-monitor.adoc @@ -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. diff --git a/docs/pages/wireless-networking/creative-wireless-fluid-grid.adoc b/docs/pages/wireless-networking/creative-wireless-fluid-grid.adoc new file mode 100644 index 0000000000..826c8ed429 --- /dev/null +++ b/docs/pages/wireless-networking/creative-wireless-fluid-grid.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/wireless-networking/creative-wireless-grid.adoc b/docs/pages/wireless-networking/creative-wireless-grid.adoc new file mode 100644 index 0000000000..afec341bcf --- /dev/null +++ b/docs/pages/wireless-networking/creative-wireless-grid.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/wireless-networking/index.adoc b/docs/pages/wireless-networking/index.adoc new file mode 100644 index 0000000000..c53e50660b --- /dev/null +++ b/docs/pages/wireless-networking/index.adoc @@ -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[] diff --git a/docs/pages/wireless-networking/network-card.adoc b/docs/pages/wireless-networking/network-card.adoc new file mode 100644 index 0000000000..22b0387b00 --- /dev/null +++ b/docs/pages/wireless-networking/network-card.adoc @@ -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[]. \ No newline at end of file diff --git a/docs/pages/wireless-networking/network-receiver.adoc b/docs/pages/wireless-networking/network-receiver.adoc new file mode 100644 index 0000000000..129245787d --- /dev/null +++ b/docs/pages/wireless-networking/network-receiver.adoc @@ -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. diff --git a/docs/pages/wireless-networking/network-transmitter.adoc b/docs/pages/wireless-networking/network-transmitter.adoc new file mode 100644 index 0000000000..06fbe6ad02 --- /dev/null +++ b/docs/pages/wireless-networking/network-transmitter.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/wireless-networking/networks-over-long-distances.adoc b/docs/pages/wireless-networking/networks-over-long-distances.adoc new file mode 100644 index 0000000000..68cf575e84 --- /dev/null +++ b/docs/pages/wireless-networking/networks-over-long-distances.adoc @@ -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. \ No newline at end of file diff --git a/docs/pages/wireless-networking/wireless-crafting-monitor.adoc b/docs/pages/wireless-networking/wireless-crafting-monitor.adoc new file mode 100644 index 0000000000..0f1adc02a1 --- /dev/null +++ b/docs/pages/wireless-networking/wireless-crafting-monitor.adoc @@ -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 +|=== \ No newline at end of file diff --git a/docs/pages/wireless-networking/wireless-fluid-grid.adoc b/docs/pages/wireless-networking/wireless-fluid-grid.adoc new file mode 100644 index 0000000000..156b6b3e0d --- /dev/null +++ b/docs/pages/wireless-networking/wireless-fluid-grid.adoc @@ -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 +|=== \ No newline at end of file diff --git a/docs/pages/wireless-networking/wireless-grid.adoc b/docs/pages/wireless-networking/wireless-grid.adoc new file mode 100644 index 0000000000..3c97561aeb --- /dev/null +++ b/docs/pages/wireless-networking/wireless-grid.adoc @@ -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 +|=== \ No newline at end of file diff --git a/docs/pages/wireless-networking/wireless-transmitter.adoc b/docs/pages/wireless-networking/wireless-transmitter.adoc new file mode 100644 index 0000000000..fc36318945 --- /dev/null +++ b/docs/pages/wireless-networking/wireless-transmitter.adoc @@ -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[] \ No newline at end of file diff --git a/docs/partials/fluid-storage-block.adoc b/docs/partials/fluid-storage-block.adoc new file mode 100644 index 0000000000..bcd8ca1c0e --- /dev/null +++ b/docs/partials/fluid-storage-block.adoc @@ -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[] diff --git a/docs/partials/fluid-storage-disk.adoc b/docs/partials/fluid-storage-disk.adoc new file mode 100644 index 0000000000..31d982c8e9 --- /dev/null +++ b/docs/partials/fluid-storage-disk.adoc @@ -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[] diff --git a/docs/partials/processor.adoc b/docs/partials/processor.adoc new file mode 100644 index 0000000000..be8f0c1465 --- /dev/null +++ b/docs/partials/processor.adoc @@ -0,0 +1 @@ +The {doctitle} is used to craft the various Refined Storage devices. \ No newline at end of file diff --git a/docs/partials/recoloring.adoc b/docs/partials/recoloring.adoc new file mode 100644 index 0000000000..8b738763fb --- /dev/null +++ b/docs/partials/recoloring.adoc @@ -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 \ No newline at end of file diff --git a/docs/partials/search-box.adoc b/docs/partials/search-box.adoc new file mode 100644 index 0000000000..19fd9dbbde --- /dev/null +++ b/docs/partials/search-box.adoc @@ -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. \ No newline at end of file diff --git a/docs/partials/storage-block.adoc b/docs/partials/storage-block.adoc new file mode 100644 index 0000000000..c5546fc5b2 --- /dev/null +++ b/docs/partials/storage-block.adoc @@ -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[] \ No newline at end of file diff --git a/docs/partials/storage-disk.adoc b/docs/partials/storage-disk.adoc new file mode 100644 index 0000000000..3a99788559 --- /dev/null +++ b/docs/partials/storage-disk.adoc @@ -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[]