docs: add asciidoc docs for use with refinedsites

This commit is contained in:
raoulvdberge
2023-11-26 18:31:35 +01:00
parent 27442fbfac
commit b489a3db8f
237 changed files with 3175 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 501 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 635 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 478 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 703 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 479 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 353 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 509 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 437 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 501 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 686 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 477 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 370 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 502 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 404 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 478 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 685 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 470 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 456 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.6 KiB

BIN
docs/assets/cable.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 365 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 516 B

BIN
docs/assets/constructor.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
docs/assets/controller.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
docs/assets/cover.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
docs/assets/crafter.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 561 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 472 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 477 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 561 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 573 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 577 B

BIN
docs/assets/cut-silicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 524 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 513 B

BIN
docs/assets/destructor.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
docs/assets/detector.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

BIN
docs/assets/disk-drive.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.6 KiB

BIN
docs/assets/exporter.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 543 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 501 B

BIN
docs/assets/filter.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 491 B

BIN
docs/assets/fluid-grid.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 554 B

BIN
docs/assets/grid.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

BIN
docs/assets/importer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 507 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 490 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 560 B

BIN
docs/assets/interface.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 555 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/assets/pattern.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 477 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 499 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 559 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 564 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 295 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 331 B

BIN
docs/assets/reader.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 848 B

BIN
docs/assets/relay.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 618 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

BIN
docs/assets/silicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 369 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 563 B

BIN
docs/assets/solderer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 523 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 554 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 487 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
docs/assets/upgrade.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 524 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 561 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 573 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 577 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 403 B

BIN
docs/assets/wrench.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 663 B

BIN
docs/assets/writer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

9
docs/component.json Normal file
View File

@@ -0,0 +1,9 @@
{
"name": "Refined Storage",
"version": "0.0.0",
"pagesPath": "pages/",
"pageTemplateOverrides": {
"index.adoc": "refined-storage-index"
},
"assetsPath": "assets/"
}

427
docs/nav.json Normal file
View File

@@ -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"
}
]
}
]

View File

@@ -0,0 +1,76 @@
= Commands
[cols="1,1"]
|===
|Refined Storage version|Command |Explanation
|v1.9.5 or higher |`/refinedstorage disk create <player> <id>`|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 <player>`|Lists all disks on the server, that the given player created.
|v1.9.5 or higher |`/refinedstorage network list <dimension>`|Lists all networks in a dimension, sorted by highest tick time first.
|v1.9.5 or higher |`/refinedstorage network get <dimension> <pos>`|Gets information about a network in a dimension and position.
|v1.9.5 or higher |`/refinedstorage network get <dimension> <pos> autocrafting list`|Gets all autocrafting tasks for a network.
|v1.9.5 or higher |`/refinedstorage network get <dimension> <pos> autocrafting get <id>`|Gets a specific autocrafting task in a network.
|v1.9.5 or higher |`/refinedstorage network get <dimension> <pos> autocrafting cancel`|Cancels all autocrafting tasks in a network.
|v1.9.5 or higher |`/refinedstorage network get <dimension> <pos> autocrafting cancel <id>`|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> <item> <metadata> <id>`
==== 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.

Some files were not shown because too many files have changed in this diff Show More