docs: add asciidoc docs for use with refinedsites

2023-11-26 18:31:35 +01:00
parent 27442fbfac
commit b489a3db8f
237 changed files with 3175 additions and 0 deletions
--- a/docs/pages/upgrades/crafting-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/fortune-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/index.adoc
+++ 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[]
--- a/docs/pages/upgrades/interdimensional-upgrade.adoc
+++ 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).
--- a/docs/pages/upgrades/range-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/regulator-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/silk-touch-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/speed-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/stack-upgrade.adoc
+++ 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.
--- a/docs/pages/upgrades/upgrade.adoc
+++ 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].