From 53b8dad30f87e0bf9322a69764266fd579520cfd Mon Sep 17 00:00:00 2001 From: Michael Hillcox Date: Tue, 9 Feb 2021 21:29:25 +0000 Subject: [PATCH] Create README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..977e619 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Auto-Clicker-Fabric + +Quick and dirty Auto Clicker mod for Fabric(mc) + +[![GitHub license](https://img.shields.io/github/license/MichaelHillcox/Auto-Clicker-Fabric)](https://github.com/MichaelHillcox/Auto-Clicker-Fabric/blob/main/LICENSE) +[![GitHub stars](https://img.shields.io/github/stars/MichaelHillcox/Auto-Clicker-Fabric)](https://github.com/MichaelHillcox/Auto-Clicker-Fabric/stargazers) +[![GitHub issues](https://img.shields.io/github/issues/MichaelHillcox/Auto-Clicker-Fabric)](https://github.com/MichaelHillcox/Auto-Clicker-Fabric/issues) +![GitHub all releases](https://img.shields.io/github/downloads/michaelhillcox/Auto-Clicker-Fabric/total) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/michaelhillcox/Auto-Clicker-Fabric) +![GitHub Release Date](https://img.shields.io/github/release-date/michaelhillcox/Auto-Clicker-Fabric) +![GitHub last commit](https://img.shields.io/github/last-commit/michaelhillcox/Auto-Clicker-Fabric) +[![Build Status](https://ci.mikey.pro/buildStatus/icon?job=Auto-Clicker-Fabric%2Fmain)](https://ci.mikey.pro/job/Auto-Clicker-Fabric/job/main/) + + +[![Discord invite link](.github/assets/discord-join-badge.svg)](https://discord.gg/yYNuqJxucJ) + +## Features +- Auto click (hold & spam) for Right and Left click +- Support for AFK farms when respecting cool down +- Configurable spam timeout (speed) +- (almost) No janky key press logic, all native Minecraft key button handling. + +## How to use (Subject to change) +- Open GUI with `O` (default key) to enable and edit the settings of each button being clicked +- Use `I` (default key) to enable auto clicker + +### Option descriptions +- `Active`: Enables that key to be held when `Auto Clicker` is active (holding) +- `Spamming`: Enables per tick spamming meaning every tick the button is quickly pressed and un-pressed +- `Speed`: Speed controls how fast (per tick) the spamming will happen, 0 being the quickest, 10 being the fastest +- `Respect cooldown`: Will Attack only once the cooldown has cooled down :tada: + +## Previews + +The [Imgur Album](https://imgur.com/a/ASZXIiO) +![Auto Clicker](https://i.imgur.com/CgQk5uE.png) + +## Use on public servers + +I **DO NOT** support the use of this mod on any public servers which do not allow this kind of mod. The mod **does** work on servers but I do not approve of, and will not, support anyone that attempts to use this mod on servers. I **do not** have the time to review each issue; I will simply close any issue with server connections in the crash log. + +If you wish to use this mod on private servers then that's on you. If you use this on public servers and are banned then that's on you and I will **not** support your use of this mod in that way.