Skip to content

Commit

Permalink
Update autocraft readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dthigpen committed Jan 6, 2022
1 parent 6172080 commit e0d1d9f
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 60 deletions.
73 changes: 13 additions & 60 deletions autocraft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,78 +4,31 @@ Automate the crafting process with a redstone enabled crafting table.
## Installation

1. Visit the Releases page and download autocraft datapack zip file and resource pack.
2. Download the [v1.2.0 PlayerDB Datapack](https://github.com/rx-modules/PlayerDB/releases/tag/v1.2.0) `.zip` datapack.
3. Copy the downloaded datapack zip files into your world's datapacks folder at `%APPDATA%\.minecraft\saves\world\datapacks`
4. Copy the resource pack into the Minecraft Resource Pack area, and enable it.
2. Copy the downloaded datapack zip file into your world's datapacks folder at `%APPDATA%\.minecraft\saves\<world>\datapacks` or `~/.minecraft/saves/<world>/datapacks`
3. Copy the resource pack into the Minecraft Resource Pack area, and enable it.
4. Launch the world and type `/reload`
5. Check that the datapack is installed under the "Installed Datapacks" Advancement tab with `Ctrl + L`


## Usage

### Crafting an Autocrafter Block
There are two variations of Autocrafter, item specific and generic. The item specific Autocrafter only crafts for a specific result, rejecting any item configurations not defined by its set recipes. The generic Autocrafter can access any recipe in the game making it very flexible. At this stage in development one should prefer to use the item specifc crafters if they intend to create a large number of them, as the generic autocrafters may create lag when used at scale.

<details><summary>Generic Autocrafter Recipe</summary>

A generic Autocrafter is created by combining a `crafting_table` and `dropper`. Since it is a shapeless recipe any positioning of the ingredients with work. See the [Guide](#Guide) section for more details.

</details>

<details><summary>Item specific Autocrafter Recipe</summary>

Create an autocrafter for nearly any item in the game with the following recipe formula,
`crafting_table + dropper + <item-of-choice> = autocrafter`. Since it is a shapeless recipe any positioning of the ingredients with work. See the [Guide](#Guide) section for more details.

<img src="docs/iron_block_autocrafter_recipe.jpg" width=200>
<img src="docs/iron_block_autocrafter_opened.jpg" width=200>
</details>

### Autocrafter Recipe

### How it Works
An Autocrafter can be created by combining a `crafting_table` and `dropper` in any position.

The autocrafter will only work when there is a `hopper` below it. Lock the `hopper` and fill in the items for the recipe, then unlock the `hopper` to craft the item. Items filled into the autocrafter will **not** stack if there are spaces available. For example if three iron ingots are fed into the slot, they will spread to take up three slots as opposed to one.
<p align="center">
<img src="docs/recipe.png" />
</p>

<img src="docs/autocrafter2.png" width=200>
### How to Use

While the hopper under the autocrafter is powered (locked) it will not attempt to craft any items. When unlocked (unpowered) the item will attempt to be crafted then pulled by the hopper.
The Autocrafter block acts nearly the same as an ordinary crafting table with the exception that the ingredients grid does **not** allow item stacking if slots are free. This is so that hoppers and droppers can place items into the grid in an automated fashion. For example, if a stack of items is placed in the table, they will be redistributed to fill the free slots.

Crafting items is straightforward for blocks such as an `iron_block` composed of nine ingots, but more complicated for shaped recipes like a `hopper`, requiring slots of air between some items. This can be accomplished my using placeholder items that get filtered out after.

## Guide
<details>
<summary>Single Ingredient Recipes </summary>
Crafting recipes with a single ingredient do not require any additional redstone components to operate the autocrafter besided the hopper below. Items fed into the autocrafter will automatically be crafted and sent below immediately.
<br>
<img src="docs/single_ingredient_recipe_crafting.png" width=200>

</details>

<details>
<summary>Multiple Ingredient Recipes </summary>
Crafting recipes with multiple ingredients require locking the hopper for all ticks that the autocrafter is being loaded with the ingredients so that they do not fall through before the recipe is completed. Once loaded, the hopper can be unlocked and the item will be crafted.
<br>
<img src="docs/locked_autocrafter.png" width=190>
<img src="docs/iron_block_autocrafter_opened.jpg" width=200>

</details>

<details>
<summary>Shaped Recipe Crafting </summary>
Shaped recipes require placeholder items to be fed into slots that would be empty. These items must then be filtered out so that only the recipe ingredients remain. Depending on the recipe, this can require a fairly complex redstone setup.
<br>
<img src="docs/redstone_torch_autocrafter_recipe.png" width=200>
<img src="docs/redstone_torch_autocrafter_opened.png" width=200>

</details>

---
## Caveats and Limitations
- Currently only single item stacks are supported in the autocraft. For example, it will not craft when there are 2+ ingredients in a stack
When an enabled hopper is placed under the Autocrafter, the result slot will be pulled into the hopper. If the result slot is empty, the ingredients grid items will be pulled. For shaped recipes, it may be necessary to fill free slots with placeholders that must then be filtered out before the recipe can be crafted.

## TODO
- Item specific custom models to indicate autocrafter type

- Add guide for redstone crafting
- Speed optimizations
- Support for item stacks
- Comparator interaction
- Interaction with hopper cooldown
- Verify hopper cooldown correctness
Binary file removed autocraft/docs/autocrafter.png
Binary file not shown.
Binary file removed autocraft/docs/autocrafter2.png
Binary file not shown.
Binary file removed autocraft/docs/locked_autocrafter.png
Binary file not shown.
Binary file modified autocraft/docs/recipe.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 removed autocraft/docs/recipe2.png
Binary file not shown.
Binary file removed autocraft/docs/redstone_torch_autocrafter_opened.png
Binary file not shown.
Binary file removed autocraft/docs/redstone_torch_autocrafter_recipe.png
Binary file not shown.
Binary file removed autocraft/docs/single_ingredient_recipe_crafting.png
Binary file not shown.

0 comments on commit e0d1d9f

Please sign in to comment.