Skip to content

Commit fe5654c

Browse files
committed
docs: move Quick Start section above Table of Contents
1 parent 779664f commit fe5654c

1 file changed

Lines changed: 29 additions & 27 deletions

File tree

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,33 +19,6 @@ visualization, UI debugging, and AI-driven cursor path prediction.
1919
[![FastKeyboard Showcase](docs/screenshot.png)](https://www.youtube.com/watch?v=VbJ62zXcASs&list=PL-mASGDMkCUqJ0bXAJP28ykqPP9RqMMsA&index=19)
2020

2121
---
22-
## Table of Contents
23-
24-
- [Why FastGhostMouse?](#why-fastghostmouse)
25-
- [Quick Start](#quick-start)
26-
- [Features](#features)
27-
- [Quick Start](#quick-start)
28-
- [Installation](#installation)
29-
- [License](#license)
30-
31-
---
32-
33-
## Why FastGhostMouse?
34-
35-
When building automation bots, AI models, or testing frameworks, visualizing what the software is actually doing is one of the hardest challenges. Standard Java solutions for drawing on the screen suffer from severe limitations:
36-
37-
- **The Focus Stealing Problem**: Standard undecorated `JFrame` overlays often steal window focus from the target application, immediately breaking the bot's interactions.
38-
- **Heavy Rendering Pipelines**: Relying on full-blown UI frameworks to draw a simple cursor trail consumes massive CPU/GPU resources, degrading the performance of the game or app you are trying to automate.
39-
- **Input Blocking**: Most overlay solutions accidentally intercept mouse clicks or keyboard events, preventing the user (or the bot) from interacting with the UI beneath the overlay.
40-
41-
**FastGhostMouse** bypasses these limitations by hooking directly into the Windows OS rendering pipeline:
42-
43-
- **True Click-Through (`WS_EX_TRANSPARENT`)**: Built on native JNI bindings, the overlay is mathematically invisible to mouse and keyboard events. You can click right through it.
44-
- **Zero-Focus Disruption (`WS_EX_NOACTIVATE`)**: The overlay is guaranteed to never steal focus from your active game or application.
45-
- **Featherweight Footprint**: Optimized to draw simple geometry (like an AI cursor trail or prediction nodes) with near-zero latency and negligible CPU cost.
46-
47-
---
48-
4922
## Quick Start
5023

5124
```java
@@ -73,6 +46,35 @@ public class Example {
7346

7447
---
7548

49+
---
50+
51+
## Table of Contents
52+
53+
- [Why FastGhostMouse?](#why-fastghostmouse)
54+
- [Quick Start](#quick-start)
55+
- [Features](#features)
56+
- [Quick Start](#quick-start)
57+
- [Installation](#installation)
58+
- [License](#license)
59+
60+
---
61+
62+
## Why FastGhostMouse?
63+
64+
When building automation bots, AI models, or testing frameworks, visualizing what the software is actually doing is one of the hardest challenges. Standard Java solutions for drawing on the screen suffer from severe limitations:
65+
66+
- **The Focus Stealing Problem**: Standard undecorated `JFrame` overlays often steal window focus from the target application, immediately breaking the bot's interactions.
67+
- **Heavy Rendering Pipelines**: Relying on full-blown UI frameworks to draw a simple cursor trail consumes massive CPU/GPU resources, degrading the performance of the game or app you are trying to automate.
68+
- **Input Blocking**: Most overlay solutions accidentally intercept mouse clicks or keyboard events, preventing the user (or the bot) from interacting with the UI beneath the overlay.
69+
70+
**FastGhostMouse** bypasses these limitations by hooking directly into the Windows OS rendering pipeline:
71+
72+
- **True Click-Through (`WS_EX_TRANSPARENT`)**: Built on native JNI bindings, the overlay is mathematically invisible to mouse and keyboard events. You can click right through it.
73+
- **Zero-Focus Disruption (`WS_EX_NOACTIVATE`)**: The overlay is guaranteed to never steal focus from your active game or application.
74+
- **Featherweight Footprint**: Optimized to draw simple geometry (like an AI cursor trail or prediction nodes) with near-zero latency and negligible CPU cost.
75+
76+
---
77+
7678

7779
## Features
7880

0 commit comments

Comments
 (0)