Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/readme'
Browse files Browse the repository at this point in the history
  • Loading branch information
RoanH committed Jan 17, 2024
2 parents 7de74fe + 79f3ea4 commit 34c8810
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
# <img src="KeysPerSecond/resources/kps.png" width="40"/> KeysPerSecond [![](https://img.shields.io/github/release/RoanH/KeysPerSecond.svg)](https://github.com/RoanH/KeysPerSecond/releases) [![](https://img.shields.io/github/downloads/RoanH/KeysPerSecond/total.svg)](#downloads)

KeysPerSecond is a program that counts how many times certain keys and mouse buttons are pressed. It can also various statistics such as the average, maximum and current number of pressed per second. The program can also show a nice graph of the key presses over time. Almost all aspects of the program are also fully customizable.
KeysPerSecond is a program that counts how many times certain keys and mouse buttons are pressed. It can also show various statistics such as the average, maximum and current number of pressed per second. The program can also show a graph of the key presses over time. Almost all aspects of the program are also fully customisable.

[Jump directly to downloads](#downloads)

# Introduction
Originally I wanted to know how many keys I pressed per second in osu! And I had already seen programs like this on live streams.
I could however not find a program that worked well on my computer so I decided to write one myself.
Originally I wanted to know how many keys I pressed per second in osu! and I had already seen programs like this on live streams.
However, I could not find a program that worked well on my computer so I decided to write one myself.

The program when active looks like this:
![Interface](https://media.roanh.dev/keyspersecond/kps1.png) ![Preview](https://media.roanh.dev/keyspersecond/preview.gif)
![Interface](https://media.roanh.dev/keyspersecond/kps2.png)
There is also a right click menu to configure all the settings:
![Menu](https://media.roanh.dev/keyspersecond/rmenu.png)
![Menu](https://media.roanh.dev/keyspersecond/rmenu88.png)

For each configured key the program will show how many times it was pressed. By default it will also show the maximum, average and current number of keys pressed per second.
When enabled it can also show a graph of the number of keys pressed per second over time and the total number of keys pressed.
When enabled it can also show a graph of the number of keys pressed per second over time, the total number of keys pressed, and the time since the last input.

Everything shown in the pictures above can be toggled on or off and all the panels can be arranged in a lot of different ways.
![Config](https://media.roanh.dev/keyspersecond/cmain.png) ![Key config](https://media.roanh.dev/keyspersecond/ckeys.png)
![Layout](https://media.roanh.dev/keyspersecond/clayout.png)
Everything shown in the pictures above can be toggled on or off and all the panels can be rearranged freely.
![Config](https://media.roanh.dev/keyspersecond/cmain88.png)

There are also some commands that can be sent to the program:
**Ctrl + P**: Causes the program to reset the average and maximum value.
**Ctrl + U**: Terminates the program.
**Ctrl + I**: Causes the program to reset the key press statistics.
**Ctrl + Y**: Shows / hides the GUI.
**Ctrl + T**: Pauses / resumes the counter.
**Ctrl + R**: Reloads the configuration file.
**Ctrl + Y**: Shows the GUI or hides it to the system tray.
**Ctrl + T**: Pauses or resumes the input tracking and panel updates.
**Ctrl + R**: Reloads the current configuration file.

You can also move the program using the arrow keys or snap it to the edges of your screen.

Expand All @@ -39,10 +37,11 @@ And if you find any bugs feel free to report them. If you have any features you'
- You can add any number of keys or mouse buttons to the program.
- To change a GUI colour in the colours menu, click on the current colour
- You can move the window with the arrow keys at 3 different speeds 1, 2 & 3 pixels at a time (2=Ctrl, 3=Shift).
- You can configure a configuration to open on launch, see [this wiki page](https://github.com/RoanH/KeysPerSecond/wiki) for more details. Essentially, you can pass the path to the config file to load via the command line or a shortcut or set the program as the default program to open `.kps` files.
- When resetting something it will also be printed to the console if this program is running using cmd/shell.
- You can configure a configuration to open on launch, see [this wiki page](https://github.com/RoanH/KeysPerSecond/wiki) for more details. Essentially, you can use the default config option, pass the path to the config file to load via the command line, use a shortcut, or set the program as the default program to open `.kps` files.
- When resetting something it will also be printed to the console if this program is running using cmd/shell.
- The overlay option is far from perfect, it just asks the OS to place the program on top. It'll not overlay most full screen games. [For some people](https://youtu.be/E_WHAaI_-Zw) running the program in Windows 98 / ME compatibility mode makes it so it can overlay full screen osu! so if you're lucky this might work.
- If you have an old configuration file (kpsconf1 or kpsconf2) then you need to convert it with [version 8.4](https://github.com/RoanH/KeysPerSecond/releases/tag/v8.4) to load it in more recent versions.
- If you have an old configuration file (kpsconf1 or kpsconf2) then you need to convert it with [version 8.4](https://github.com/RoanH/KeysPerSecond/releases/tag/v8.4) to load it in more recent versions.
- Windowed mode can help on operating systems that do not properly support borderless windows (e.g., chromebooks). Note that transparent windows are not supported in windowed mode.

## Downloads
_Requires Java 8 or higher_
Expand Down

0 comments on commit 34c8810

Please sign in to comment.