From a70f868120cc22a1a08537cd681394f7fa61db04 Mon Sep 17 00:00:00 2001 From: futile Date: Sat, 11 Jul 2026 07:50:57 +0100 Subject: [PATCH] update readme --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6a2a6e7..d21e012 100644 --- a/README.md +++ b/README.md @@ -16,34 +16,35 @@ Download the latest release [here](https://gitlab.com/futile/gta-tools/-/release **Option 2** — Build from source You will need Rust, which you can get [here](https://rustup.rs). Then, clone this repo and navigate to it. At this point, you should probably `git checkout x.x.x`, where `x.x.x` is the latest tag. You can then run `cargo build --release`. Once you do that, you can use the binary located at `.\target\release\gta-tools.exe` in the same way as **Option 1**. -It is recommended to always use an up-to-date version of GTA Tools from [releases](https://gitlab.com/futile/gta-tools/-/releases). You can also easily access this repository by going to the About page of GTA Tools and clicking the git button beside the version number. +> [!NOTE] +> It is recommended to always use an up-to-date version of GTA Tools from [releases](https://gitlab.com/futile/gta-tools/-/releases). You can also easily access this repository by going to the About page of GTA Tools and clicking the git button beside the version number. ## Guide -Every feature of GTA Tools is Legacy/Enhanced-agnostic. GTA Tools requires administrator access. +Every feature of GTA Tools works for both Legacy and Enhanced version of the game. GTA Tools requires administrator access. #### Game This section is quite simple. -There is a Launch feature, which will start your game on the chosen launcher and game version. +Launch — Starts your game on the chosen launcher and game version. -There is also a Force close game feature, which simply kills all game processes. This button requires a second press after the first one for confirmation. This *does not* touch Rockstar Games Launcher or any other processes, only ones named `GTA5_Enhanced.exe` or `GTA5.exe`. +Force close game — Kills all game processes. The button requires a second press after the first one for confirmation. This *does not* touch Rockstar Games Launcher or any other processes, only ones named `GTA5_Enhanced.exe` or `GTA5.exe`. #### Session This section also has two features. -The first being Empty current session, which "removes everyone" from your session by blocking the game's network access for 10 seconds, then unblocking it. This can be useful in numerous ways: +Empty current session — Clears your session of players[^1] by blocking the game's network access for 10 seconds, then unblocking it. This can be useful in numerous ways: * You are stuck loading into a session * You are stuck loading into an interior * You are about to get griefed while doing a freemode mission * You want to quickly get a "new" session -The other feature is Anti AFK, which, when toggled, prevents you from getting kicked for idling by pressing keys on your keyboard every 60 seconds. At present, those keys are `VK_NUMPAD4` & `VK_NUMPAD6`, due to being a relatively good balance of keys that the game actually registers but don't interrupt gameplay too much if they activate while you're playing. You *must* be tabbed into GTA V for Anti AFK to work. While toggled, Anti AFK will only activate when all of the following conditions are true: +Anti AFK — Prevents you from getting kicked for idling by pressing keys on your keyboard every 60 seconds. At present, those keys are `VK_NUMPAD4` & `VK_NUMPAD6`, due to being a relatively good balance of keys that the game actually registers but don't interrupt gameplay too much if they activate while you're playing. You *must* be tabbed into GTA V for Anti AFK to work. While toggled, Anti AFK will only activate when all of the following conditions are true: * The `Grand Theft Auto V` window is currently focused -* None of the designated keys are currently being pressed[^1] -* The mouse cursor is not currently visible[^2] +* None of the designated keys are currently being pressed[^2] +* The mouse cursor is not currently visible[^3] #### Network @@ -69,5 +70,6 @@ Here's how you can do a replay glitch using this alternative method: -[^1]: Otherwise, if you are, for example, using those keys to fly a plane, Anti AFK activating could cancel the input. -[^2]: Specifically, the Windows mouse cursor, not the in-game mouse cursor. This check is mostly used to prevent typing while you are in the Rockstar overlay. +[^1]: Technically, it just makes you lose connection to the session. But it looks like everyone left you instead. +[^2]: Otherwise, if you are, for example, using those keys to fly a plane, Anti AFK activating could cancel the input. +[^3]: Specifically, the Windows mouse cursor, not the in-game mouse cursor. This check is mostly used to prevent typing while you are in the Rockstar overlay.