Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
Signed-off-by: Emanuel Pilz <[email protected]>
  • Loading branch information
emonadeo committed Nov 8, 2024
1 parent 70167f8 commit 4902205
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,42 @@
# Auto-Run

[![Modrinth](https://img.shields.io/modrinth/dt/2i7tg1Wv?logo=modrinth&label=Modrinth)](https://modrinth.com/mod/autorun)
[![CurseForge](https://img.shields.io/curseforge/dt/279429?logo=curseforge&label=CurseForge&color=orange)](https://www.curseforge.com/minecraft/mc-mods/autorun-fabric)
[![GitHub](https://img.shields.io/github/downloads/emonadeo/autorun/total?logo=github&label=GitHub&color=blue)](https://github.com/Emonadeo/autorun/releases)

Hands-free walking and sprinting in Minecraft

## Installation

Download the JAR and place it into your .minecraft/mods folder. If it doesn't exist create it.
You can download the Auto-Run mod on [GitHub](https://github.com/Emonadeo/autorun/releases), [CurseForge](https://www.curseforge.com/minecraft/mc-mods/autorun-fabric) or [Modrinth](https://modrinth.com/mod/autorun).

Other distributions are not endorsed.
Please let me know if you find any other website distributing this mod.

See https://docs.fabricmc.net/players/installing-mods on how to install mods.

### Dependencies

> [!IMPORTANT]
> This mod requires [Fabric API](https://modrinth.com/mod/fabric-api) like most other Fabric mods.
Install these mods alongside Auto-Run.

> [!NOTE]
> This mod is client-side only, meaning it should only be installed on the client and not on servers.
- [Fabric API](https://modrinth.com/mod/fabric-api) is **required**
- [Mod Menu](https://modrinth.com/mod/modmenu) and [Cloth Config API](https://modrinth.com/mod/cloth-config) are **optional**

## Usage

Press 'O' to toggle automatic walking. You can also hit the sprint key to sprint while auto-walking.
Press <kbd>O</kbd> to toggle Auto-Run.
If you hold a specific direction during activation, it will in that direction.
You can also hit the sprint key to sprint while auto-walking.

This keybind can be customized in the controls options.

## FAQ

### Can I use it in my modpack?

Yes.
**Yes.**

### Where can I download the mod?
### Do I need to install Auto-Run on the server?

The only official distributions are [GitHub](https://github.com/Emonadeo/autorun/releases), [CurseForge](https://www.curseforge.com/minecraft/mc-mods/autorun-fabric) and [Modrinth](https://modrinth.com/mod/autorun). Please let me know if you find any other website distributing this mod.
**No.** In fact you should **not** install it on the server.
This is a **client-side only** mod and should only be installed on the client.

0 comments on commit 4902205

Please sign in to comment.