Skip to content

Commit

Permalink
Updated Guidebook Content (#7433)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sea-Kerman committed Oct 5, 2023
1 parent 56ba1cf commit 453f1f6
Show file tree
Hide file tree
Showing 24 changed files with 229 additions and 27 deletions.
19 changes: 12 additions & 7 deletions guidebook/ae2-mechanics/autocrafting.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,19 @@ certain addons for extra mod material types, like Mekanism gasses, those materia

It is quite a complex topic, so strap in and let's go.

An autocrafting setup consists of 3 things: the thing sending the crafting request, the crafting CPU, and the <ItemLink id="pattern_provider" />.
An autocrafting setup consists of 3 things:
- The thing sending the crafting request
- The crafting CPU
- The <ItemLink id="pattern_provider" />.

Here is what happens:

1. Something creates a crafting request. This can be you in the terminal clicking on something autocraftable,
or an export bus or interface with a crafting card requesting one of the item they're set to export/stock.

* (**IMPORTANT:** use whatever you have bound to "pick block" (usually middle-mouse) to request crafts of something you already have in stock, this can conflict with inventory sorting mods),

2. The ME system calculates the required ingredients and prerequisite crafting steps to fulfill the request, and stores them in a crafting CPU
2. The ME system calculates the required ingredients and prerequisite crafting steps to fulfill the request, and stores them in the selected crafting CPU

3. The <ItemLink id="pattern_provider" /> with the relevant [pattern](../items-blocks-machines/patterns.md) pushes the ingredients specified in the pattern to any adjacent inventory.
In the case of a crafting table recipe (a "crafting pattern") this will be a <ItemLink id="molecular_assembler" />.
Expand Down Expand Up @@ -97,17 +102,17 @@ if you have a machine that duplicates cobblestone.

Crafting CPUs manage crafting requests/jobs. They store the intermediate ingredients while crafting jobs with multiple steps are
being carried out, and affect how big jobs can be, and to some degree how fast they are completed. They are multiblocks, and
must be rectangular prisms.
must be rectangular prisms with at least 1 crafting storage.

Crafting CPUs are made out of:

* [Crafting storages](../items-blocks-machines/crafting_cpu_multiblock.md), available in all the standard cell sizes (1k, 4k, 16k, 64k, 256k). They store the ingredients and
* (Required) [Crafting storages](../items-blocks-machines/crafting_cpu_multiblock.md), available in all the standard cell sizes (1k, 4k, 16k, 64k, 256k). They store the ingredients and
intermediate ingredients involved in a craft, so larger or more storages are required for the CPU to handle crafting jobs
with more ingredients.
* <ItemLink id="crafting_accelerator" />s, they make the system send out more ingredient batches from pattern providers.
* (Optional) <ItemLink id="crafting_accelerator" />s, they make the system send out more ingredient batches from pattern providers.
This allows, say, a pattern provider surrounded by 6 molecular assemblers to send ingredients to (and thus use) all 6 at once instead of just one.
* <ItemLink id="crafting_monitor" />s, they display the job the CPU is handling at the moment. They can be colored via a <ItemLink id="color_applicator" />
* <ItemLink id="crafting_unit" />s, they simply fill space in order to make the CPU a rectangular prism.
* (Optional) <ItemLink id="crafting_monitor" />s, they display the job the CPU is handling at the moment. They can be colored via a <ItemLink id="color_applicator" />
* (Optional) <ItemLink id="crafting_unit" />s, they simply fill space in order to make the CPU a rectangular prism.

Each crafting CPU handles 1 request or job, so if you want to request both a calculation processor and 256 smooth stone at once, you need 2 CPU multiblocks.

Expand Down
14 changes: 13 additions & 1 deletion guidebook/ae2-mechanics/me-network-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ navigation:
icon: fluix_glass_cable
---

# NEtwork Connections
# Network Connections

## What Does "Network" Mean?

Expand All @@ -14,6 +14,18 @@ like [cables](../items-blocks-machines/cables.md) or fullblock machines and [dev
(<ItemLink id="charger" />, <ItemLink id="interface" />, <ItemLink id="drive" />, etc.)
Technically a single cable is a network, actually.

## An Aside On Device Positioning

For [devices](../ae2-mechanics/devices.md) which have some specific network function (like an <ItemLink id="interface" />
pushing to and pulling from [network storage](../ae2-mechanics/import-export-storage.md), a <ItemLink id="level_emitter" />
reading the contents of network storage, an <ItemLink id="drive" /> being network storage, etc.)
the physical position of the device does not matter.

Again, **the physical position of the device does not matter**. All that matters is that the device is connected to the network
(and of course which network it's connected to).

## Network Connections

An easy way of determining what's connected in a network is using a <ItemLink id="network_tool" />. It will show every
component on the network, so if you see stuff you shouldn't or don't see stuff you should, you have a problem.

Expand Down
18 changes: 18 additions & 0 deletions guidebook/assets/assemblies/provider_misconception_1.snbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
DataVersion: 3465,
size: [2, 1, 4],
data: [
{pos: [0, 0, 3], state: "minecraft:oak_wall_sign{facing:west,waterlogged:false}", nbt: {back_text: {color: "black", has_glowing_text: 0b, messages: ['{"text":""}', '{"text":""}', '{"text":""}', '{"text":""}']}, front_text: {color: "black", has_glowing_text: 1b, messages: ['{"text":"Some Kind"}', '{"text":"Of Machine"}', '{"text":""}', '{"text":""}']}, id: "minecraft:sign", is_waxed: 0b}},
{pos: [1, 0, 0], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 2, channelsSouth: 2, connections: ["north", "south"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", visual: {}}},
{pos: [1, 0, 1], state: "ae2:pattern_provider{push_direction:all}", nbt: {blocking_mode: "NO", id: "ae2:pattern_provider", lock_crafting_mode: "NONE", pattern_access_terminal: "YES", priority: 0, proxy: {p: 0}, returnInv: [], sendList: [], visual: {}}},
{pos: [1, 0, 2], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, connections: ["north"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", south: {craft_only: "NO", fuzzy_mode: "IGNORE_ALL", gn: {p: 0}, id: "ae2:export_bus", nextSlot: 0, redstone_controlled: "IGNORE", scheduling_mode: "DEFAULT", visual: {missingChannel: 0b, powered: 1b}}, visual: {}}},
{pos: [1, 0, 3], state: "minecraft:blast_furnace{facing:west,lit:false}", nbt: {BurnTime: 0s, CookTime: 0s, CookTimeTotal: 0s, Items: [], RecipesUsed: {}, id: "minecraft:blast_furnace"}}
],
entities: [],
palette: [
"minecraft:oak_wall_sign{facing:west,waterlogged:false}",
"ae2:cable_bus{light_level:0,waterlogged:false}",
"ae2:pattern_provider{push_direction:all}",
"minecraft:blast_furnace{facing:west,lit:false}"
]
}
17 changes: 17 additions & 0 deletions guidebook/assets/assemblies/provider_misconception_2.snbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
DataVersion: 3465,
size: [2, 1, 4],
data: [
{pos: [0, 0, 3], state: "minecraft:oak_wall_sign{facing:west,waterlogged:false}", nbt: {back_text: {color: "black", has_glowing_text: 0b, messages: ['{"text":""}', '{"text":""}', '{"text":""}', '{"text":""}']}, front_text: {color: "black", has_glowing_text: 1b, messages: ['{"text":"Some Kind"}', '{"text":"Of Machine"}', '{"text":""}', '{"text":""}']}, id: "minecraft:sign", is_waxed: 0b}},
{pos: [1, 0, 0], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, channelsSouth: 1, connections: ["north", "south"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", visual: {}}},
{pos: [1, 0, 1], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, channelsSouth: 1, connections: ["north", "south"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", visual: {}}},
{pos: [1, 0, 2], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, connections: ["north"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", south: {craft_only: "NO", fuzzy_mode: "IGNORE_ALL", gn: {p: 0}, id: "ae2:export_bus", nextSlot: 0, redstone_controlled: "IGNORE", scheduling_mode: "DEFAULT", visual: {missingChannel: 0b, powered: 1b}}, visual: {}}},
{pos: [1, 0, 3], state: "minecraft:blast_furnace{facing:west,lit:false}", nbt: {BurnTime: 0s, CookTime: 0s, CookTimeTotal: 0s, Items: [], RecipesUsed: {}, id: "minecraft:blast_furnace"}}
],
entities: [],
palette: [
"minecraft:oak_wall_sign{facing:west,waterlogged:false}",
"ae2:cable_bus{light_level:0,waterlogged:false}",
"minecraft:blast_furnace{facing:west,lit:false}"
]
}
18 changes: 18 additions & 0 deletions guidebook/assets/assemblies/provider_misconception_3.snbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
DataVersion: 3465,
size: [2, 1, 4],
data: [
{pos: [0, 0, 3], state: "minecraft:oak_wall_sign{facing:west,waterlogged:false}", nbt: {back_text: {color: "black", has_glowing_text: 0b, messages: ['{"text":""}', '{"text":""}', '{"text":""}', '{"text":""}']}, front_text: {color: "black", has_glowing_text: 1b, messages: ['{"text":"Some Kind"}', '{"text":"Of Machine"}', '{"text":""}', '{"text":""}']}, id: "minecraft:sign", is_waxed: 0b}},
{pos: [1, 0, 0], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, channelsSouth: 1, connections: ["north", "south"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", visual: {}}},
{pos: [1, 0, 1], state: "ae2:cable_bus{light_level:0,waterlogged:false}", nbt: {cable: {gn: {p: 0}, id: "ae2:blue_smart_cable", visual: {channelsNorth: 1, channelsSouth: 1, connections: ["north", "south"], missingChannel: 0b, powered: 1b}}, hasRedstone: 2, id: "ae2:cable_bus", visual: {}}},
{pos: [1, 0, 2], state: "ae2:pattern_provider{push_direction:all}", nbt: {blocking_mode: "NO", id: "ae2:pattern_provider", lock_crafting_mode: "NONE", pattern_access_terminal: "YES", priority: 0, proxy: {p: 0}, returnInv: [], sendList: [], visual: {}}},
{pos: [1, 0, 3], state: "minecraft:blast_furnace{facing:west,lit:false}", nbt: {BurnTime: 0s, CookTime: 0s, CookTimeTotal: 0s, Items: [], RecipesUsed: {}, id: "minecraft:blast_furnace"}}
],
entities: [],
palette: [
"minecraft:oak_wall_sign{facing:west,waterlogged:false}",
"ae2:cable_bus{light_level:0,waterlogged:false}",
"ae2:pattern_provider{push_direction:all}",
"minecraft:blast_furnace{facing:west,lit:false}"
]
}
Binary file added guidebook/assets/diagrams/minus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guidebook/assets/diagrams/plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions guidebook/example-setups/advanced-certus-farm.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ to do it automatically.
The cluster breaker subnet works very similarly to the subnet in the [simple certus farm](simple-certus-farm.md).

1. The <ItemLink id="annihilation_plane" /> attempts to break what is in front of it, but can only break <ItemLink id="quartz_cluster" />
because the only storage on the subnet is the <ItemLink id="formation_plane" />, filtered to <ItemLink id="certus_quartz_crystal" />.
because the only storage on the subnet is the <ItemLink id="storage_bus" />, filtered to <ItemLink id="certus_quartz_crystal" />.
2. The <ItemLink id="storage_bus" /> stores the certus quartz crystals in the barrel.

### Certus Block Breaker
Expand All @@ -125,7 +125,7 @@ The certus block breaker subnet serves to break the depleted budding block once
It works similarly to the cluster breaker.

1. The <ItemLink id="annihilation_plane" /> attempts to break what is in front of it, but can only break <ItemLink id="quartz_block" />
because the only storage on the subnet is the <ItemLink id="formation_plane" />, filtered to <ItemLink id="quartz_block" />.
because the only storage on the subnet is the <ItemLink id="storage_bus" />, filtered to <ItemLink id="quartz_block" />.
The plane needs to have silk touch, so the budding block won't degrade upon being broken, and thus the plane won't break it prematurely.
2. The <ItemLink id="storage_bus" /> stores the certus quartz block in the <ItemLink id="interface" />, allowing the
[Throwing-In-Water Automation](throw-in-water-automation.md) to use it to make a new <ItemLink id="flawed_budding_quartz" />.
Expand Down
3 changes: 3 additions & 0 deletions guidebook/example-setups/charger-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ navigation:

# Charger Automation

Note that since this uses a <ItemLink id="pattern_provider" />, it is meant to integrate into your [autocrafting](../ae2-mechanics/autocrafting.md)
setup. If you just want to automate a <ItemLink id="charger" /> standalone, use hoppers and chests and stuff.

Automation of a <ItemLink id="charger" /> is fairly simple. A <ItemLink id="pattern_provider" /> pushes the ingredient into the charger, then a [pipe subnet](pipe-subnet.md)
or other item pipe pushes the result back into the provider.

Expand Down
3 changes: 3 additions & 0 deletions guidebook/example-setups/furnace-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ navigation:

# Furnace Automation

Note that since this uses a <ItemLink id="pattern_provider" />, it is meant to integrate into your [autocrafting](../ae2-mechanics/autocrafting.md)
setup. If you just want to automate a furnace standalone, use hoppers and chests and stuff.

Automation of a <ItemLink id="minecraft:furnace" /> is a bit more complex than automation of simpler machines like a [charger](../example-setups/charger-automation.md).
A furnace requires input from two separate sides, and extraction from a third. The item to be smelted must be pushed in the top face,
the fuel must be pushed in a side face, and the result must be pulled out the bottom.
Expand Down
3 changes: 3 additions & 0 deletions guidebook/example-setups/processor-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ long as you can filter it.

Here is detailed how to do it with just AE2, using ["pipe" subnets](pipe-subnet.md).

Note that since this uses a <ItemLink id="pattern_provider" />, it is meant to integrate into your [autocrafting](../ae2-mechanics/autocrafting.md)
setup. If you just want to automate a processors standalone, replace the pattern provider with another barrel, and directly put the ingredients in the upper barrel.

This happens to be backwards-compatible
with previous AE2 versions, because even if the <ItemLink id="inscriber" />s are sided, the pipe subnets still insert to and
extract from the correct faces.
Expand Down
4 changes: 2 additions & 2 deletions guidebook/example-setups/semiauto-certus-farm.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ This farm is a bit more complex than the [simple certus farm](simple-certus-farm
The cluster breaker subnet works very similarly to the subnet in the [simple certus farm](simple-certus-farm.md).

1. The <ItemLink id="annihilation_plane" /> attempts to break what is in front of it, but can only break <ItemLink id="quartz_cluster" />
because the only storage on the subnet is the <ItemLink id="formation_plane" />, filtered to <ItemLink id="certus_quartz_crystal" />.
because the only storage on the subnet is the <ItemLink id="storage_bus" />, filtered to <ItemLink id="certus_quartz_crystal" />.
2. The <ItemLink id="storage_bus" /> stores the certus quartz crystals in the barrel.

### Certus Block Breaker
Expand All @@ -124,7 +124,7 @@ The certus block breaker subnet serves to break the depleted budding block once
It works similarly to the cluster breaker.

1. The <ItemLink id="annihilation_plane" /> attempts to break what is in front of it, but can only break <ItemLink id="quartz_block" />
because the only storage on the subnet is the <ItemLink id="formation_plane" />, filtered to <ItemLink id="quartz_block" />.
because the only storage on the subnet is the <ItemLink id="storage_bus" />, filtered to <ItemLink id="quartz_block" />.
The plane needs to have silk touch, so the budding block won't degrade upon being broken, and thus the plane won't break it prematurely.
2. The <ItemLink id="storage_bus" /> stores the certus quartz block in the spent
buddng certus barrel, you will have to manually throw it in water with <ItemLink id="charged_certus_quartz_crystal" /> to refresh it.
Expand Down
3 changes: 3 additions & 0 deletions guidebook/example-setups/throw-in-water-automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ navigation:

# Automation of Throwing In Water recipes

Note that since this uses a <ItemLink id="pattern_provider" />, it is meant to integrate into your [autocrafting](../ae2-mechanics/autocrafting.md)
setup.

Some recipes require items to be thrown into water (though a similar setup can be used to throw items other places).
This can be automated with a <ItemLink id="formation_plane" />, <ItemLink id="annihilation_plane" />, and some supporting
infrastructure (this is essentially 2 modified [pipe subnets](pipe-subnet.md)).
Expand Down
13 changes: 13 additions & 0 deletions guidebook/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ navigation:
title: Index/Table of Contents
position: 0
---
# What is Applied Energistics 2?

# How To Use This Guide

* Access the sidebar on the left to find a table of contents
* Many pages have interactive scenes. If a scene has ![Plus](assets/diagrams/plus.png)
and ![Minus](assets/diagrams/minus.png) (zoom) buttons next to it, you can rotate and move the camera.
Left click and drag to rotate, right click and drag to translate.

# What is Applied Energistics 2?

Expand All @@ -17,3 +25,8 @@ quantities of items in stock, crafting more as needed, or simply transfer items
* [AE2 Mechanics](ae2-mechanics/ae2-mechanics-index.md)
* [Example Setups](example-setups/example-setups-index.md)
* [Items, Blocks, and Machines](items-blocks-machines/items-blocks-machines-index.md)

<GameScene zoom="4" interactive={true}>
<ImportStructure src="assets/assemblies/autocraft_setup_greebles.snbt" />
<IsometricCamera yaw="195" pitch="30" />
</GameScene>
2 changes: 2 additions & 0 deletions guidebook/items-blocks-machines/annihilation_plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ you'd expect it to, efficiency reduces the energy cost of breaking a block, and

They are [cable subparts](../ae2-mechanics/cable-subparts.md).

**REMEMBER TO ENABLE FAKE PLAYERS IN YOUR CHUNK CLAIM**

## Filtering

The annihilation plane will only break a block or pick up an item if it can store the resulting drops/items
Expand Down
2 changes: 1 addition & 1 deletion guidebook/items-blocks-machines/color_applicator.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ item_ids:
<ItemImage id="color_applicator" scale="4" />

The color applicator is used to paint colorable blocks like [cables](cables.md), wool, terracotta, glass, and concrete. It uses
[paintballs](paintballs.md) or dyes, and snowballs can eb used in order to clean color off of cables and paintball splotches off of blocks.
[paintballs](paintballs.md) or dyes, and snowballs can be used in order to clean color off of cables and paintball splotches off of blocks.

Its energy can be recharged in a <ItemLink id="charger" />.

Expand Down
Loading

0 comments on commit 453f1f6

Please sign in to comment.