Skip to content

Commit

Permalink
add themes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeki The Monkey committed Jun 26, 2021
1 parent 052970b commit 7d6530f
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 11 deletions.
File renamed without changes
File renamed without changes
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,32 @@ KPS is a simple program that shows keystates, keys per second, total keys and cu
# Preview
![](preview.gif)

![](modification-demo.gif)

It supports up to 10 keys. Buttons, font, color, background, animation and other things can be changed in the config.

# Download
TODO

# Usage
To modify keys in program press Ctrl + Q, then click the button to change with the **left mouse button** or with the **same key** to select it, then press the key that will replace the old one. To deselect a button click with left mouse button on it. To exit from edit mode press Ctrl + Q.
Modifications can be done in edit mode, which can be open/closed by pressing Ctrl + Q.
If you want to add/remove a key press +/-, but if you want to change a key, click with left mouse button or with the same key, then the key will be selected, and it will change its own color, then press the key that will replace the old one.
These actions look like:

To exit from program press Ctrl + W or close it from the tray.
![](modification-demo.gif)

To edit anything else use KPS.cfg. Any settings value must have a space after semicolon, and if there are several values, such as keys or some digits, they must be separated with comma and do not have any space between.

To know what keys and buttons can be written in the config check SFML documentation - [Keyboard keys](https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Keyboard.php), [Mouse buttons](https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Mouse.php). Arrow keys can be written like so - UpArrow, DownArrow etc.
Other settings can be changed in the KPS.cfg file, that will be generated in the same directory after you run the program. If there is already one, nothing will be generated, but if there is any error, error log will be generated.
When you change anything in the config you must put one space between semicolon and the rest of the data. If this data are some numbers or keys, they must be separated with a comma without any extra space between. If it is a path to a texture or font, it must be written without any quotes.
To exit the program just click Ctrl + W or close it from the tray.

To edit font, button, animation or background texture write the path (without quotes) to the asset.
To know what keys and buttons can be written in the config check SFML documentation - [Keyboard keys](https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Keyboard.php), [Mouse buttons](https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Mouse.php). Arrow keys can be written like so - UpArrow, DownArrow etc.

# Notes
BPM is not accurate, it will be calcuted correctly only after a second and 9 frames.
- BPM is not calculated immediately, it will be displayed correctly only after a second and 9 frames.
- If you want to have non-square buttons, you have to set the path to the texture with your button, but also you have to change the animation texture, because it is still squared, - just put the same texture, but white one.

# Themes
![](preview.gif)

![](Preset-1.gif)

![](Preset-2.gif)

# License
Licensed under the [MIT License](LICENSE).

0 comments on commit 7d6530f

Please sign in to comment.