Skip to content

Commit

Permalink
Updated README.md, added demo gif
Browse files Browse the repository at this point in the history
  • Loading branch information
PsychedelicShayna committed Dec 28, 2021
1 parent 8e1d7ce commit 327eaff
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Cursor Locker
This is a simple program that confines your cursor to any game or application window, for games that do not natively do so and cause problems with multiple monitors where the cursor might escape onto the second or third monitor and issue unintended inputs. You can download a pre-compiled version in the [releases section](https://github.com/MisanthropicShayna/CursorLocker/releases) if you'd rather not compile it yourself. This project uses Qt5 which is cross-platform, however it is currently only compatible with Windows since it relies on WinAPI to function.
This is a simple program that confines your cursor to any game or application window, for games that do not natively do so and cause problems with multiple monitors where the cursor might escape onto the second or third monitor and issue unintended inputs.

## Downloads
You can download a pre-compiled build in the [releases section](https://github.com/MisanthropicShayna/CursorLocker/releases), which has been compiled with MSVC19 using Qt version 6.2.1. While Qt is cross-platform, the project relies on WinAPI to function, therefore only a Windows build is available.

## Building
If you plan to build the project yourself using the intended method, you will need a [Qt5 Environment](https://www.qt.io/download-open-source) and a copy of the Qt runtime DLLs to make it portable, which you can acquire by running `windeployqt.exe C:\path\to\binary\<cursorlocker.exe>` that ships with Qt. You can also find the Qt runtime DLLs included in the pre-compiled release.
If you plan to build the project yourself using the intended method, you will need a [Qt6 Environment](https://www.qt.io/download-open-source) and a copy of the needed Qt runtime DLLs to make it portable, which you can acquire by running the `windeployqt.exe` binary that ships with Qt, like so: `windeployqt.exe C:\path\to\binary\cursor-locker.exe` -- you can also find the Qt runtime DLLs included in the pre-compiled release, or in the Qt install directory.

The repository includes a Qt `.pro` project file which is already pre-configured and should work straight out of the box. You will however need a compatible compiler such as MSVC15 or MSVC17 -- or really just any compiler that is compatible with Windows libraries.
The repository includes a Qt `.pro` project file which you can use to compile the project, assuming you have a Qt/qmake environment, and a compiler compatible with Windows libraries, such as MSVC17 or MSVC19.

## Screenshot
![](screenshots/screenshot-3.png?raw=true)
## Demo Gif
![](screenshots/demo_10fps.gif?raw=true)
Binary file modified screenshots/demo_10fps.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 327eaff

Please sign in to comment.