Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
9fca677
feat(probe): isolate visible, hidden and warp cursor behaviors
quasistatic-setup Oct 27, 2026
71c4a64
feat(ui): support explicit A/B test panel and live marker count
quasistatic-setup Oct 27, 2026
60e9258
feat(ui): support explicit A/B test panel and live marker count
quasistatic-setup Oct 27, 2026
bd04379
feat(ui): support explicit A/B test panel and live marker count
quasistatic-setup Oct 27, 2026
21c0502
feat(ui): support explicit A/B test panel and live marker count
quasistatic-setup Oct 27, 2026
fabcbdc
feat(ui): surface A/B marker count and complete test hotkeys
quasistatic-setup Oct 27, 2026
468b89c
feat(ui): support explicit A/B test panel and live marker count
quasistatic-setup Oct 27, 2026
ade88ba
fix(probe): handle unknown control notifications safely
quasistatic-setup Oct 27, 2026
febea0e
ci: bundle MouseLookProbe with Windows diagnostic artifacts
quasistatic-setup Oct 27, 2026
d784cde
docs: describe A/B marker panel and three probe modes
quasistatic-setup Oct 27, 2026
bf2efd9
docs: record marker UI and three-mode probe verification
quasistatic-setup Oct 27, 2026
53b18b7
docs: record marker UI and three-mode probe verification
quasistatic-setup Oct 27, 2026
2225fea
feat(ab): allow interactive or CLI target executable override per ses…
quasistatic-setup Oct 27, 2026
d7be1df
feat(ab): prompt for target executable when launcher is double-clicked
quasistatic-setup Oct 27, 2026
cea8ecb
ui(ab): name selected executable as TARGET in status panel
quasistatic-setup Oct 27, 2026
eb727a2
docs: explain runtime target EXE selection for A/B tests
quasistatic-setup Oct 27, 2026
9688046
ui(ab): consistently label non-WoW target status
quasistatic-setup Oct 27, 2026
5a24f08
docs: record generic executable selection
quasistatic-setup Oct 27, 2026
581256f
docs: record generic executable selection
quasistatic-setup Oct 27, 2026
9a79639
docs: clarify TARGET label for A/B executable selection
quasistatic-setup Oct 27, 2026
835af6d
feat(ab): load target EXE from AB-Test.ini instead of prompting
quasistatic-setup Oct 27, 2026
85a69c6
fix(ab): validate INI executable basename safely
quasistatic-setup Oct 27, 2026
113dc7f
feat(ab): provide editable INI target selection for test profile
quasistatic-setup Oct 27, 2026
b544815
chore(ab): start directly using INI target instead of prompting
quasistatic-setup Oct 27, 2026
9b42bc0
build: package AB-Test.ini beside executable
quasistatic-setup Oct 27, 2026
1ab1ddb
docs(ab): explain persistent target selection in AB-Test.ini
quasistatic-setup Oct 27, 2026
e4f0655
docs(ab): explain persistent target selection in AB-Test.ini
quasistatic-setup Oct 27, 2026
e92972e
docs(ab): explain persistent target selection in AB-Test.ini
quasistatic-setup Oct 27, 2026
cdd9775
docs(ab): explain persistent target selection in AB-Test.ini
quasistatic-setup Oct 27, 2026
4eca037
feat(target): prepare shared INI and optional full-image-path target …
quasistatic-setup Oct 27, 2026
79ece05
feat(target): prepare shared INI and optional full-image-path target …
quasistatic-setup Oct 27, 2026
2cfdf77
feat(target): prepare shared INI and optional full-image-path target …
quasistatic-setup Oct 27, 2026
93a3731
feat(target): prepare shared INI and optional full-image-path target …
quasistatic-setup Oct 27, 2026
1f303f4
feat(config): read A/B and playing targets as name or path from share…
quasistatic-setup Oct 27, 2026
aeb4767
config: use [AB-Test] section of shared INI
quasistatic-setup Oct 27, 2026
01957a9
config: use [Playing] section of shared INI
quasistatic-setup Oct 27, 2026
e6b158b
feat(config): separate A/B and playing targets in shared INI
quasistatic-setup Oct 27, 2026
fedaa8e
chore(config): replace single-profile AB-Test.ini with shared INI
quasistatic-setup Oct 27, 2026
d46cd70
build: ship shared RemoteMouseFix.ini with both launchers
quasistatic-setup Oct 27, 2026
fd8ab2a
docs: configure independent A/B and playing targets by filename or path
quasistatic-setup Oct 27, 2026
7b63844
docs: configure independent A/B and playing targets by filename or path
quasistatic-setup Oct 27, 2026
5555175
docs: configure independent A/B and playing targets by filename or path
quasistatic-setup Oct 27, 2026
4757bf3
fix(playing): keep error message visible for invalid INI target
quasistatic-setup Oct 27, 2026
6bbb30e
docs: accept optional quotes around INI executable paths
quasistatic-setup Oct 27, 2026
4375bd0
docs: accept optional quotes around INI executable paths
quasistatic-setup Oct 27, 2026
f0469e4
docs: accept optional quotes around INI executable paths
quasistatic-setup Oct 27, 2026
205d30f
feat(diagnostics): integrate opt-in 250ms correction timing and ancho…
quasistatic-setup Oct 27, 2026
ed77504
feat(diagnostics): enable opt-in timing trace in isolated A/B profile
quasistatic-setup Oct 27, 2026
dceeedc
feat(diagnostics): enable opt-in timing trace in isolated A/B profile
quasistatic-setup Oct 27, 2026
cc8c4df
feat(diagnostics): enable opt-in timing trace in isolated A/B profile
quasistatic-setup Oct 27, 2026
28f2fc6
docs(diagnostics): explain timing events and a focused WoW/Probe test…
quasistatic-setup Oct 27, 2026
a0ccac5
docs: describe integrated timing trace and separate rotating A/B logs
quasistatic-setup Oct 27, 2026
b049df8
chore: document timing integration and isolated log rotation
quasistatic-setup Oct 27, 2026
1f8aa66
ci: upgrade checkout and artifact upload to Node.js 24 actions
quasistatic-setup Oct 27, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
name: MSVC x64
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v7

- name: Configure
# No -G: CMake picks the newest Visual Studio on the runner image.
Expand All @@ -24,8 +24,11 @@ jobs:
- name: Stage the release layout
run: cmake --install build --config Release --prefix stage/RemoteMouseFix-win-x64

- name: Include MouseLookProbe in diagnostic artifact
run: Copy-Item build/bin/Release/MouseLookProbe.exe stage/RemoteMouseFix-win-x64/MouseLookProbe.exe

- name: Upload the build output
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: RemoteMouseFix-win-x64
path: stage/RemoteMouseFix-win-x64
Expand Down
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ correction is still experimental.

## [Unreleased]

### Added

- A/B profile enables the optional 250 ms `## TIMING` summary for incoming deltas,
timer gaps, blocked anchor gates and queued movement. Normal playing remains unchanged.
- A/B diagnostic logs are isolated in `logs-ab/` with up to 50 retained files;
game logs remain in `logs/`. Back up original captures outside rotating folders.


- MouseLookProbe now provides visible/no-warp, hidden/no-warp and hidden/warp
modes to distinguish cursor hiding from cursor repositioning. The original
hidden/warp mode remains the default for automated regression testing.
- Both `Start-AB-Test.cmd` and `Start-Playing.cmd` read independent
targets from `[AB-Test]` and `[Playing]` in `RemoteMouseFix.ini`.
Select by executable filename or a full absolute path (exact process-image
match). Missing or invalid INI settings fail safely before correction.
The tool does not launch the configured game.
- The A/B console displays Ctrl+Alt+M, the number of markers written and all
correction/diagnostic hotkeys.
- The CI diagnostic artifact includes MouseLookProbe.exe for direct tests.


## [0.7.0] - 2026-09-21

### Added
Expand Down
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ add_custom_command(TARGET RemoteMouseFix POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_if_different
"${CMAKE_SOURCE_DIR}/config/Start-AB-Test.cmd"
"${CMAKE_SOURCE_DIR}/config/Start-Playing.cmd"
"${CMAKE_SOURCE_DIR}/config/RemoteMouseFix.ini"
"$<TARGET_FILE_DIR:RemoteMouseFix>"
COMMENT "Staging the shipped layout next to RemoteMouseFix.exe")

Expand All @@ -108,6 +109,7 @@ install(TARGETS RemoteMouseFix InputEchoCheck RUNTIME DESTINATION .)
install(FILES
config/Start-AB-Test.cmd
config/Start-Playing.cmd
config/RemoteMouseFix.ini
README.md LICENSE
DESTINATION .)
install(FILES
Expand Down
98 changes: 81 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ in a folder of its own:
README.md LICENSE
config/ the three profiles
docs/ diagnostic reference
logs/ created on the first start
logs/ created by Start-Playing.cmd
logs-ab/ created by Start-AB-Test.cmd
```

### Windows warnings on first start
Expand Down Expand Up @@ -79,27 +80,64 @@ colour repeats the answer: green means working, yellow means waiting for you, re
the fix stopped itself.

```text
GAME * Wow.exe is in front
TARGET * Wow.exe is in front
FIX * on (absolute) - correcting the pointer
WORK 20 jumps seen, 51 corrections applied
MARK #2 Ctrl+Alt+M = mark the start of a test section in the log
NEXT > Everything is working. Ctrl+Alt+C switches the fix off at any time.
KEYS Ctrl+Alt+1 fix on | Ctrl+Alt+C fix off | Ctrl+Alt+P pause log | Ctrl+Alt+Q quit
MODES Ctrl+Alt+1 absolute | Ctrl+Alt+2 relative | Ctrl+Alt+C OFF
KEYS Ctrl+Alt+M MARK | Ctrl+Alt+P pause log | Ctrl+Alt+Q quit
```

`GAME` is yellow while the game is not running or while another window is in front: the
fix only works on the window you are actually playing in, so clicking into the game is
what turns this line green. `FIX` turns red when a watchdog switched the correction off,
`TARGET` in A/B mode (or `GAME` in the normal profile) is yellow while the
selected executable is not running or another window is in front. The fix only
works while that target window is in the foreground, so switching to it turns
the line green. `FIX` turns red when a watchdog switched the correction off,
and then says why; that state stays on screen instead of scrolling away. `NEXT` always
names the one thing to do next.

Set `NO_COLOR=1` for a monochrome panel. When the output is redirected to a file, the
panel is printed once per change instead of being repainted.

Both launchers read their own section of `RemoteMouseFix.ini` next to
`RemoteMouseFix.exe`:

```ini
[AB-Test]
Executable=MouseLookProbe.exe

[Playing]
Executable=C:\Games\World of Warcraft\Wow.exe
```

Use `Executable=Wow.exe` to match any running game process with that filename,
**regardless of its installation directory**. Alternatively supply a full
absolute Windows path to match **only that exact executable installation**.
Spaces in the path are supported. Enclosing the whole value in double quotes is optional;
Windows removes them when reading the INI. Your runtime test confirmed both forms.
Change the INI while the tool is stopped, save, and start the desired
`Start-AB-Test.cmd` or `Start-Playing.cmd` launcher as usual. No startup
question or JSON edit is needed. The shipped file uses `Wow.exe` for both
sections, and the settings persist across sessions.

RemoteMouseFix **does not launch a game**. The path selects the process to
monitor and correct when the game is already running and in the foreground.
The selected target is shown as `TARGET` in A/B mode (or `GAME` in the
regular playing display). A missing INI or invalid target fails closed
before correction starts. The diagnostic-only profile remains unchanged.

The A/B profile additionally shows the number of markers written so far and all
test hotkeys. Each press of `Ctrl+Alt+M` creates the next numbered `## MARKER #N`
entry. Keep a short note of what each marker represents; a marker identifies a
section boundary, not its meaning. An immediate notice confirms each marker.

### Controls

| Hotkey | Effect |
| --- | --- |
| `Ctrl+Alt+C` | switch the correction off immediately |
| `Ctrl+Alt+M` | add a numbered marker to the log |
| `Ctrl+Alt+P` | pause/resume logging (correction continues) |
| `Ctrl+Alt+1` | enable the recommended `absolute` correction |
| `Ctrl+Alt+2` | enable the alternative `relative` correction |
| `Ctrl+Alt+Q` | quit RemoteMouseFix cleanly |
Expand All @@ -126,13 +164,19 @@ can still add latency.

## Report a problem or test another setup

The A/B profile records detailed mouse movement for comparison. It never records keyboard
input or text, and it has no upload or network feature. You decide whether to share a log.
The A/B profile records detailed mouse movement and opt-in 250 ms timing summaries
(`## TIMING`) to distinguish missing remote input, irregular timers and
unsent movement gated by the cursor anchor. Test logs are written to `logs-ab/`
separately from normal-play `logs/`; up to 50 files are retained, but the
oldest still rotate out. Copy important captures into an archive outside the
rotating folders. The tool never records keyboard input or text, and it has no
upload or network feature. You decide whether to share a log.

1. Start the game and move to a quiet, safe location.
2. Double-click `Start-AB-Test.cmd` from the RemoteMouseFix folder.
3. Confirm that the console names `config-ab-test.json` and that the panel shows
`FIX` on with `absolute`, and `GAME` turning green when you click into the game.
3. Confirm that the console names `config-ab-test.json`, that `TARGET` shows
the executable from `[AB-Test]` in `RemoteMouseFix.ini`, and that `FIX` is on with `absolute`.
`TARGET` turns green when you click into the chosen application.
4. Test the same actions in each mode: `absolute`, `off`, then `relative`.
Use `Ctrl+Alt+1`, `Ctrl+Alt+C` and `Ctrl+Alt+2` to select the modes.
5. Before every action, press `Ctrl+Alt+M` to add a marker to the log:
Expand All @@ -141,7 +185,7 @@ input or text, and it has no upload or network feature. You decide whether to sh
- hold the left mouse button and drag slowly.
6. Note for each mode whether the camera is smooth, jumps, or moves too fast or too slowly.
7. Press `Ctrl+Alt+C`, then `Ctrl+Alt+Q`.
8. Open the newest file in `logs` and check that its final lines report `queue drops 0`
8. Open the newest file in `logs-ab` and check that its final lines report `queue drops 0`
and `watchdog trips 0`.
9. ZIP that log and attach it to a
[GitHub issue](https://github.com/quasistatic-setup/RemoteMouseFix/issues/new) together
Expand Down Expand Up @@ -242,13 +286,15 @@ Keys beginning with `_` in the supplied configuration files are explanatory comm

| Key | Built-in default | Meaning |
| --- | --- | --- |
| `target_process` | `Wow.exe` | executable to observe, matched case-insensitively |
| `target_process` | `Wow.exe` | fallback target name; the A/B and Playing profiles select their executable from `RemoteMouseFix.ini` |
| `target_ini_section` | empty | `AB-Test` or `Playing` enables that named section in `RemoteMouseFix.ini` for a name or full-path match |
| `diagnostic_mode` | `true` | `true` prevents all correction; `false` permits correction modes |
| `correction_mode` | `off` | startup mode: `off`, `absolute` or `relative` |
| `watchdog_max_hidden_ms` | `180000` | hidden cursor duration before correction is disabled; `0` disables this check |
| `watchdog_max_unechoed` | `50` | own events allowed outstanding before the echo watchdog trips |
| `watchdog_max_output_failures` | `5` | consecutive failed output calls before the watchdog trips |
| `log_mouse_moves` | `true` | `false` records buttons, wheel and state only |
| `trace_correction_timing` | `false` | opt-in 250 ms timer/anchor/pending-delta summaries; enabled in A/B profile |
| `log_directory` | `logs` | relative paths resolve beside the EXE |
| `log_file_prefix` | `remotemousefix` | log filename prefix |
| `max_log_bytes` | `8388608` | rotate after this size |
Expand All @@ -261,8 +307,9 @@ Keys beginning with `_` in the supplied configuration files are explanatory comm
| `console_status_interval_ms` | `2000` | live console interval; `0` disables it |
| `heartbeat_interval_ms` | `10000` | log heartbeat interval; `0` disables it |

Log files rotate by prefix. Copy a log you want to retain out of `logs` before taking many
further captures.
Log files rotate by prefix. The A/B profile uses `logs-ab/` (50 files maximum) and
normal playing uses `logs/` (5 files maximum). Copy any log you wish to preserve
into another folder before taking more captures.

## Build from source

Expand Down Expand Up @@ -306,9 +353,26 @@ kind of input this check sends, so its filter, not the system, would decide the

## Developer test with MouseLookProbe

`MouseLookProbe.exe` reproduces the measured mouse-look mechanism without the game. It
hides the cursor on a button press, warps it to an off-centre anchor and records the summed
movement of each phase in `mouselook-probe.log`.
`MouseLookProbe.exe` has three selectable experiment modes to isolate why
TeamViewer pauses during mouse-look. The original hidden-cursor + warp behavior
remains the default, including for the automated script.

| Probe mode | Cursor | Repeated `SetCursorPos` | Purpose |
| --- | --- | --- | --- |
| A – visible / no warp | visible | no | character-selection-like baseline |
| B – hidden / no warp | hidden | no | isolate cursor hiding |
| C – hidden + warp | hidden | yes | original WoW-like mouse-look simulation |

Choose a radio button in the probe window before dragging. Hold the left or right
mouse button in the empty area, then release before switching modes. Modes A/B use
ordinary `GetCursorPos` deltas, so keep drags short to avoid the screen edge.
Each phase records its selected mode in `mouselook-probe.log`. The optional
`--mode visible|hidden|warp` selects the initial mode; `warp` is the default.

Test A, B and C via TeamViewer first **without RemoteMouseFix targeting the probe**.
Pauses only in C suggest repeated cursor repositioning; pauses in B and C suggest
that hiding the cursor contributes. These are indicators rather than proof of
WoW behavior: the probe is only an approximation of the game's input loop.

[tools/probe/emulate-remote.ps1](tools/probe/emulate-remote.ps1) starts both programs,
injects a TeamViewer-shaped absolute stream and runs a click without motion, a steady drag
Expand Down
13 changes: 13 additions & 0 deletions config/RemoteMouseFix.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
; RemoteMouseFix target selection. Save changes before starting a launcher.
; Give the EXE filename OR a complete Windows path to the game EXE.
; A full path limits correction to the matching game installation.
; Quotation marks around the full value are optional; Windows strips them when reading.
; This tool does NOT launch the executable.
; Example: Executable=C:\Games\World of Warcraft\Wow.exe
; Example: Executable=D:\Games\AnotherGame\Game.exe

[AB-Test]
Executable=Wow.exe

[Playing]
Executable=Wow.exe
5 changes: 5 additions & 0 deletions config/Start-AB-Test.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,8 @@
setlocal
title RemoteMouseFix A/B correction test
"%~dp0RemoteMouseFix.exe" "%~dp0config\config-ab-test.json" %*
if errorlevel 1 (
echo.
echo RemoteMouseFix could not start. Review the error above.
pause
)
5 changes: 5 additions & 0 deletions config/Start-Playing.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,8 @@
setlocal
title RemoteMouseFix gameplay
"%~dp0RemoteMouseFix.exe" "%~dp0config\config-play.json" %*
if errorlevel 1 (
echo.
echo RemoteMouseFix could not start. Review the error above.
pause
)
13 changes: 10 additions & 3 deletions config/config-ab-test.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
{
"_about": "RemoteMouseFix A/B test configuration: absolute correction starts immediately and can be switched by hotkey. Keys starting with _ are comments.",

"_target_process": "Executable to observe, matched case-insensitively on the file name.",
"_target_process": "A/B target is set in [AB-Test] of RemoteMouseFix.ini beside the EXE.",
"target_process": "Wow.exe",
"_target_ini_section": "Read the target from [AB-Test] in RemoteMouseFix.ini beside the EXE, supporting a filename or full executable path.",
"target_ini_section": "AB-Test",

"_diagnostic_mode": "true: input is never modified and no correction mode can be enabled. false: correction modes become available (see config-ab-test.json).",
"diagnostic_mode": false,

"_log_mouse_moves": "false records buttons, wheel and state transitions only, which keeps logs small.",
"log_mouse_moves": true,

"_show_ab_test_ui": "Show marker number and complete hotkeys in the A/B status panel.",
"show_ab_test_ui": true,

"_correction_mode": "Starts in absolute. Switch while running: Ctrl+Alt+1 absolute, Ctrl+Alt+2 relative, Ctrl+Alt+C off.",
"correction_mode": "absolute",

Expand All @@ -19,12 +24,12 @@
"watchdog_max_output_failures": 5,

"_log_directory": "Relative paths resolve next to RemoteMouseFix.exe.",
"log_directory": "logs",
"log_directory": "logs-ab",
"log_file_prefix": "remotemousefix",

"_rotation": "Roll over past max_log_bytes and keep at most max_log_files files.",
"max_log_bytes": 8388608,
"max_log_files": 5,
"max_log_files": 50,

"_flush_on_button": "Flush after every button event so a crash still keeps the interesting moment.",
"flush_on_button": true,
Expand All @@ -38,6 +43,8 @@
"_state_poll_interval_ms": "Sampling period for cursor visibility, ClipCursor state and anchor learning.",
"state_poll_interval_ms": 10,
"log_state_changes": true,
"_trace_correction_timing": "Log 250 ms timing/anchor-gate summaries while absolute correction is active and the target holds the cursor.",
"trace_correction_timing": true,

"_console_status_interval_ms": "Live counter refresh in the console. 0 disables it.",
"console_status_interval_ms": 2000,
Expand Down
2 changes: 2 additions & 0 deletions config/config-play.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"_about": "RemoteMouseFix gameplay configuration: absolute correction starts immediately. Keys starting with _ are comments.",

"target_process": "Wow.exe",
"_target_ini_section": "Read the target from [Playing] in RemoteMouseFix.ini beside the EXE, supporting a filename or full executable path.",
"target_ini_section": "Playing",
"diagnostic_mode": false,
"log_mouse_moves": false,
"correction_mode": "absolute",
Expand Down
Loading