Guidebook

CHANGELOG.md

@@ -1 +1 @@
-- fix #307
+- add guidebook pages

build.gradle.kts

@@ -147,6 +147,12 @@ neoForge {
         create("server") {
             server()
         }
+
+        create("guide") {
+            client()
+            systemProperty("guideDev.ae2guide.startupPage", "ae2:index.md")
+            systemProperty("guideDev.ae2guide.sources", file("src/main/resources/assets/ae2wtlib/ae2guide").absolutePath)
+        }
     }
 }
 

src/main/resources/assets/ae2/ae2guide/items-blocks-machines/wireless_terminals.md

@@ -0,0 +1,55 @@
+---
+navigation:
+  parent: items-blocks-machines/items-blocks-machines-index.md
+  title: Wireless Terminals
+  icon: wireless_crafting_terminal
+  position: 410
+categories:
+- tools
+item_ids:
+- ae2:wireless_terminal
+---
+
+# Wireless Terminal
+
+<ItemImage id="wireless_terminal" scale="4" />
+
+
+Wireless terminals are portable versions of the regular wired [terminals](terminals.md). They have the exact same UIs as their
+wired counterparts, except instead of slots for <ItemLink id="view_cell" />s, they have slots for [upgrade cards](upgrade_cards.md)
+
+In order to pair them with a network, insert the terminal in the top-right slot of a <ItemLink id="wireless_access_point" />
+connected to that network. (The slot with a picture of a wireless terminal on it and an arrow below it)
+
+They must be within range of a <ItemLink id="wireless_access_point" /> to function.
+
+Their energy can be recharged in a <ItemLink id="charger" />.
+
+# Wireless Terminal
+
+<ItemImage id="wireless_terminal" scale="4" />
+
+Your basic terminal, now portable! View and access the contents of your [network's storage](../ae2-mechanics/import-export-storage.md)
+and request things from your [autocrafting](../ae2-mechanics/autocrafting.md) setup from anywhere within the range of a
+<ItemLink id="wireless_access_point" />.
+
+## The UI
+
+See [Terminals](terminals.md)
+
+## Upgrades
+
+The Wireless Terminal supports the following [upgrades](upgrade_cards.md):
+
+*   <ItemLink id="energy_card" /> in order to increase the battery capacity
+
+## Recipe
+
+<RecipeFor id="wireless_terminal" />
+
+# Wireless Crafting Terminal
+
+<ItemImage id="wireless_crafting_terminal" scale="4" />
+
+[AE2WTLib](ae2wtlib:ae2wtlib/ae2wtlib-index.md) modifies the <ItemLink id="ae2:wireless_crafting_terminal" />.
+It is documented on a [different page](ae2wtlib:ae2wtlib/wireless_crafting_terminal.md) now.

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/ae2wtlib-index.md

@@ -0,0 +1,10 @@
+---
+navigation:
+  title: AE2WTLib
+  position: 60
+---
+
+# AE2WTLib
+
+
+<CategoryIndex category="ae2wtlib" />

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/magnet_card.md

@@ -0,0 +1,31 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: Magnet Card
+  icon: ae2wtlib:magnet_card
+  position: 220
+categories:
+- ae2wtlib
+item_ids:
+- ae2wtlib:magnet_card
+---
+
+# Magnet Card
+
+<ItemImage id="ae2wtlib:magnet_card" scale="3" />
+
+The Magnet Card is an [Upgrade Card](ae2:items-blocks-machines/upgrade_cards.md) for the <ItemLink id="ae2:wireless_crafting_terminal" />.
+It adds a magnet to the <ItemLink id="ae2:wireless_crafting_terminal" /> which can be toggled or filtered in the GUI.
+There is also a keybinding to turn it on or off.
+
+The <ItemLink id="ae2wtlib:magnet_card" /> does two things:
+
+1. Pick up items in a larger range (configurable, default is 16)
+2. Place picked up items in the ME System instead of your inventory
+
+Both can be toggled separately, and filtered separately (pickup filter and insert filter).
+Either filter can be set to blacklist or whitelist mode.
+
+## Recipe
+
+<RecipeFor id="ae2wtlib:magnet_card" />

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/quantum_bridge_card.md

@@ -0,0 +1,29 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: Quantum Bridge Card
+  icon: ae2wtlib:quantum_bridge_card
+  position: 210
+categories:
+- ae2wtlib
+item_ids:
+- ae2wtlib:quantum_bridge_card
+---
+
+# Quantum Bridge Card
+
+<ItemImage id="ae2wtlib:quantum_bridge_card" scale="3" />
+
+The Quantum Bridge Card is an [Upgrade Card](ae2:items-blocks-machines/upgrade_cards.md) for [AE2wtlib Wireless Terminals](wireless_terminals.md).
+It allows linking your [Wireless Terminals](wireless_terminals.md) to a [Quantum Bridge](ae2:items-blocks-machines/quantum_bridge.md).
+
+Put a quantum Bridge Card and a <ItemLink id="ae2:quantum_entangled_singularity" /> in your wireless terminal,
+and put the other singularity in a [Quantum Bridge](ae2:items-blocks-machines/quantum_bridge.md) connected to your network.
+
+Your Wireless Terminal is now Quantum Linked, can access your network from anywhere, even across dimensions (assuming the chunks containing the network are loaded, e.g. with a <ItemLink id="ae2:spatial_anchor" />),
+and will automatically recharge with energy from your network.
+(make sure your network has enough [energy storage](ae2:items-blocks-machines/energy_cells.md))
+
+## Recipe
+
+<RecipeFor id="ae2wtlib:quantum_bridge_card" />

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/restock.md

@@ -0,0 +1,33 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: Restocking
+  position: 110
+categories:
+- ae2wtlib
+---
+
+# Restocking
+
+If Restock is enabled, your <ItemLink id="ae2:wireless_crafting_terminal" /> will try to replace items you use with items from the ME System.
+
+You can enable it in the GUI, or using a Keybind.
+
+When enabled, it will try to keep the Stack you are using at half the stack size, so 32 for most items.
+It will take any missing items from your ME System,
+or put excess items into your ME System.
+This means that if you place a few items, then break them again, the item likely won't overflow into a different slot,
+even if you don't hava an active <ItemLink id="ae2wtlib:magnet_card" />.
+
+It will **NOT** restock stacks holding a single item before being used.
+
+It will also change the item count in your hotbar,
+to show the item count in the network (+ the items that actually are in your hotbar).
+
+It only works as long as you are in range of an access point,
+or if your terminal is [quantum linked](quantum_bridge_card.md).
+
+In creative mode, this is automatically disabled since you are not depleting items anyway.
+
+Restock works for most actions like placing blocks, eating food and shooting with a bow, restock should work,
+but other actions (especially actions from other mods) might not be recognized and items used won't be restocked.

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/wireless_crafting_terminal.md

@@ -0,0 +1,40 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: Wireless Crafting Terminal
+  icon: ae2:wireless_crafting_terminal
+  position: 100
+categories:
+- ae2wtlib
+item_ids:
+  - ae2:wireless_crafting_terminal
+---
+
+# Wireless Crafting Terminal
+
+<ItemImage id="ae2:wireless_crafting_terminal" scale="3" />
+
+The <ItemLink id="ae2:wireless_crafting_terminal" /> is a [wireless](wireless_terminals.md) version of the <ItemLink id="ae2:crafting_terminal" />.
+AE2WTLib adds automatic [restocking](restock.md) from the ME Network, and allows Pick Block to draw items from the ME Network.   
+With a <ItemLink id="ae2wtlib:magnet_card" /> it also acts as a magnet.
+
+It can be combined with other [Wireless Terminals](wireless_terminals.md) into an <ItemLink id="ae2wtlib:wireless_universal_terminal" />
+
+AE2WTLib enhances Minecrafts `Pick Block` functionality, it will draw items from the network if they can't be found in your inventory.
+(It will also try to store items if your current slot happens to be full)
+
+## The UI
+
+See [Terminals](ae2:items-blocks-machines/terminals.md)
+
+## Upgrades
+
+The Wireless Crafting Terminal supports the following [upgrades](ae2:items-blocks-machines/upgrade_cards.md):
+
+*   <ItemLink id="ae2:energy_card" /> in order to increase the battery capacity
+*   <ItemLink id="ae2wtlib:quantum_bridge_card" /> which allows the terminal to have unlimited range, even across dimensions and automatically charges the terminal from the ME Network 
+*   <ItemLink id="ae2wtlib:magnet_card" /> to add magnet functionality
+
+## Recipe
+
+<RecipeFor id="ae2:wireless_crafting_terminal" />

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/wireless_terminals.md

@@ -0,0 +1,66 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: AE2WTLib Wireless Terminals
+  icon: ae2wtlib:wireless_universal_terminal
+  position: 10
+categories:
+- ae2wtlib
+item_ids:
+  - ae2wtlib:wireless_pattern_encoding_terminal
+  - ae2wtlib:wireless_pattern_access_terminal
+---
+
+# Wireless Terminals
+
+<ItemGrid>
+  <ItemIcon id="ae2wtlib:wireless_universal_terminal" />
+  <ItemIcon id="ae2:wireless_crafting_terminal" />
+  <ItemIcon id="ae2wtlib:wireless_pattern_encoding_terminal" />
+  <ItemIcon id="ae2wtlib:wireless_pattern_access_terminal" />
+</ItemGrid>
+
+In addition to the <ItemLink id="ae2:energy_card" />, all AE2WTLib Wireless Terminals can be upgrade with the <ItemLink id="ae2wtlib:quantum_bridge_card" />
+and combined into a <ItemLink id="ae2wtlib:wireless_universal_terminal" />.
+
+Like AE2's <ItemLink id="ae2:wireless_terminal" />, it can be accessed using a Keybind and be put in a curio slot
+(if any mod implementing the curio api is installed) 
+
+## Wireless Universal Terminal
+
+<ItemImage id="ae2wtlib:wireless_universal_terminal" scale="3" />
+
+The <ItemLink id="ae2wtlib:wireless_universal_terminal" /> is a combination of multiple Wireless Terminals into one item.
+
+## Wireless Crafting Terminal
+
+<ItemImage id="ae2:wireless_crafting_terminal" scale="3" />
+
+The <ItemLink id="ae2:wireless_crafting_terminal" /> is a wireless version of the crafting terminal.
+It has some [additional functionality](wireless_crafting_terminal.md) compared to vanilla AE2.
+
+## Wireless Pattern Encoding Terminal
+
+<ItemImage id="ae2wtlib:wireless_pattern_encoding_terminal" scale="3" />
+
+A wireless version of the <ItemLink id="ae2:pattern_encoding_terminal" />
+
+<RecipeFor id="ae2wtlib:wireless_pattern_encoding_terminal" />
+
+## Wireless Pattern Access Terminal
+
+<ItemImage id="ae2wtlib:wireless_pattern_access_terminal" scale="3" />
+
+A wireless version of the <ItemLink id="ae2:pattern_access_terminal" />
+
+<RecipeFor id="ae2wtlib:wireless_pattern_access_terminal" />
+
+## Addon Terminals
+
+Most wireless terminals from other Addons also work with the <ItemLink id="ae2wtlib:wireless_universal_terminal" />.
+
+## Terminals that don't work in the universal terminal
+
+The <ItemLink id="ae2:wireless_terminal" /> can not be used in the <ItemLink id="ae2wtlib:wireless_universal_terminal" />,
+since it wouldn't provide any benefit over a <ItemLink id="ae2:wireless_crafting_terminal" />.
+It also can't use the <ItemLink id="ae2wtlib:quantum_bridge_card" />

src/main/resources/assets/ae2wtlib/ae2guide/ae2wtlib/wireless_universal_terminal.md

@@ -0,0 +1,38 @@
+---
+navigation:
+  parent: ae2wtlib/ae2wtlib-index.md
+  title: Wireless Universal Terminal
+  icon: ae2wtlib:wireless_universal_terminal
+  position: 20
+categories:
+- ae2wtlib
+item_ids:
+  - ae2wtlib:wireless_universal_terminal
+---
+
+# Wireless Universal Terminal
+
+<ItemImage id="ae2wtlib:wireless_universal_terminal" scale="3" />
+
+The <ItemLink id="ae2wtlib:wireless_universal_terminal" /> is a combination of multiple [Wireless Terminals](wireless_terminals.md) into one item.
+
+All [AE2WTLib Wireless Terminals](wireless_terminals.md) can be combined into one terminal.
+
+AE2's <ItemLink id="ae2:wireless_terminal" /> can ***NOT*** be combined into a <ItemLink id="ae2wtlib:wireless_universal_terminal" />.
+
+
+## The UI
+
+The <ItemLink id="ae2wtlib:wireless_universal_terminal" /> adds a button to the terminal UI,
+which can be left-clicked (and right-clicked) to cycle to the next (or last) [Wireless Terminal](wireless_terminals.md).
+
+
+## Upgrades
+
+The <ItemLink id="ae2wtlib:wireless_universal_terminal" /> accepts the same upgrades as the installed [Wireless Terminals](wireless_terminals.md).
+Each installed terminal adds 2 upgrade slots
+
+## Energy storage
+
+Adding terminals combines their energy storage,
+so a <ItemLink id="ae2wtlib:wireless_universal_terminal" /> with two terminals has twice the energy storage of a [Wireless Terminal](wireless_terminals.md)