diff --git a/README.md b/README.md index 5d31819..3b10182 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ # AutoTrade-fabric +## Table of contents +1. [Description](#description) +2. [Build](#build-for-1203--1204) +3. [Known Issues](#known-issues) +4. [Possible Setup](#possible-setup) +5. [Void Trading Example & Settings](#void-trading-example--settings) + +### Description + Allows you to AFK trade with villagers. Player movement is not part of this mod. You have to move between villagers and input and output containers using minecart, water stream or other methods. Use a light sensor to trade only once per day per villager to keep prices from climbing. @@ -12,17 +21,17 @@ Beginning with version v0.0.10 you can select the sell/buy items using nametagge if you can't access settings via the keybind, try modmenu https://modrinth.com/mod/modmenu -# Supported Version: +#### Supported Version: - Minecraft 1.19.4 - 1.20.4 -# Build for 1.20.3 / 1.20.4 +### Build for 1.20.3 / 1.20.4 ``` ./gradlew build ``` -# Build for older minecraft versions: +#### Build for older minecraft versions: ``` ./gradlew build -Pminecraft_version_out=1.20.2 -Pminecraft_version=1.20.2 -Pminecraft_version_min=1.20.2 -Pmalilib_version=0.17.0 -Pmod_menu_version=8.0.1 -Pmappings_version=1.20.2+build.4 @@ -30,24 +39,15 @@ if you can't access settings via the keybind, try modmenu https://modrinth.com/m ./gradlew build -Pminecraft_version_out=1.19.4 -Pminecraft_version=1.19.4 -Pminecraft_version_min=1.19.4 -Pmalilib_version=0.15.2 -Pmod_menu_version=6.1.0 -Pmappings_version=1.19.4+build.2 ``` -# Requires: +#### Requires: - malilib -# Known Issues: +### Known Issues - itemscroller trade favorites break trading -# Demo World Download - -- https://github.com/sebseb7/autotrade-fabric/releases/download/v0.0.2/AutoTradeDemo_WDL.zip -- Setup required for the Demo World Download: - -# Settings Screen - -image - -# Possible Setup +### Possible Setup - shulker unloader presenter for input - shulker loader presenter for output @@ -61,11 +61,11 @@ if you can't access settings via the keybind, try modmenu https://modrinth.com/m - on 2b2t water stream for player movement doesn't work somehow, minecart circuit works. -# Demo Video +#### Demo Video https://youtu.be/ZbxkZqb-VsU -# Void Trading Example & Settings +### Void Trading Example & Settings - selectUsingGlassBlock: true - selectionOffset: -3