From 8242b2c60191773b975ad9a2efb50fa4cf649c33 Mon Sep 17 00:00:00 2001 From: MeexReay Date: Sat, 14 Jun 2025 03:13:26 +0300 Subject: [PATCH] readme update --- README.md | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index f63c38a..43b4faa 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ This mod can record your movements and play them back. +## How to use + +Simply start recording, perform any actions, stop the recording, return to the starting point, and then you can replay everything you did. + +## Showcase + ![Preview gif](preview.gif) ## Controls @@ -10,29 +16,18 @@ Default Repeating Mod keys ``` Menu | J -Toggle recording | not specified -Toggle replay | not specified +Toggle recording | not specified by default +Toggle replay | not specified by default ``` ## Menu -How menu looks like +This is how menu looks like: ![repeating mod menu](https://github.com/MeexReay/repeating-mod/assets/127148610/4123068f-b150-45ae-8ae3-fcaa0e6bb9f8) -## Todo -Releases dont have striked lines +## Roadmap -- record gui mouse clicks and key pressing (in dev) -- create new preview.gif -- practice mode like in geometry dash for parkours - -## How to build - -How to build mod from source - -``` -gradlew build -``` - -Compiled .jar file you can find in `build/libs` +- [ ] relative mode for repeating actions (like mining) +- [ ] record mouse and keyboard in gui +- [ ] practice mode (like in geometry dash but for parkours)