Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JekiTheMonkey committed Jan 30, 2022
1 parent 8edbe14 commit 4fc766f
Show file tree
Hide file tree
Showing 24 changed files with 76 additions and 21 deletions.
Binary file removed Media/Preview-White-orange-new.gif
Binary file not shown.
Binary file removed Media/Preview-kps-window.gif
Binary file not shown.
Binary file removed Media/menu-demo.gif
Binary file not shown.
Binary file removed Media/modification-demo.gif
Binary file not shown.
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ JKPS is a program that shows keystates, keys per second, total keys and current
# Preview
The program when active looks like that:

![](Media/Previews/preview-white-orange-new.gif)
![](Wiki/Previews/white-orange-2-preview.gif)

# Usage
To add a keyboard key press **Ctrl** + **+**, to add mouse button press **Ctrl** + **>**, and to remove press **Ctrl** + **-**.
Expand All @@ -13,7 +13,7 @@ To rebind a key click with right mouse button on the button and then click the d

These actions look like:

![](Media/Previews/modifications-preview.gif)
![](Wiki/Previews/modifications-preview.gif)

To change how the program looks press **Ctrl** + **A** to open menu. If you want to change texture or font, then you have to provide it in the same directory where the program is located and then write the **whole asset name (extension included)** in corresponding text box and then press Enter or Refresh button.

Expand All @@ -37,43 +37,35 @@ Click with **right mouse button** on the button to edit it

# Key press visualization

![](Media/Previews/key-press-visualization-preview.gif)
![](Wiki/Previews/key-press-visualization-preview.gif)

# Notes
- Capture the program as a game in OBS, not as a window.
- To make the program work with greenscreen write **"GreenscreenBG.png"** in **"Main window" -> "Background texture filepath"** and press Enter or Refresh button.

# [Themes](https://gist.github.com/JekiTheMonkey/727f57dcdecb76480b982f0fe479c5c1)
# [Themes](Wiki/Themes.md)

![Media/Themes/White orange new](Media/Previews/white-orange-new-preview.gif)
![](Wiki/Previews/7k-4k-mania-white-orange-2-preview.gif)

<!-- ![](Media/Preview-ADOFAI-default-theme.gif)
![](Wiki/Previews/adofai-white-orange-2-preview.gif)

![](Media/Preview-osu!mania-7k-default-theme.gif)
![](Wiki/Previews/red-violet-preview.gif)

![](Media/Preview-White-orange-new.gif)
![](Wiki/Previews/dark-minimalistic-2-nano-preview.gif)

![](Media/Preview-Red-violet.gif)
![](Wiki/Previews/dark-minimalistic-1-nano-preview.gif)

![](Media/Preview-Dark-minimalistic-2-nano.gif)
![](Wiki/Previews/modern-purple-preview.gif)

![](Media/Preview-Medieval.gif)
![](Wiki/Previews/dark-violet-preview.gif)

![](Media/Preview-Modern-purple.gif)
![](Media/Preview-Dark-minimalistic-1-nano.gif)
![](Media/Preview-White-orange-old.gif)
![](Media/Preview-Dark-violet.gif)
![](Media/Preview-Dark-classic.gif) -->
![](Wiki/Previews/dark-classic-preview.gif)

# Links

[Download](https://github.com/JekiTheMonkey/JKPS/releases/)

[Themes](https://gist.github.com/JekiTheMonkey/727f57dcdecb76480b982f0fe479c5c1/)
[Themes](Wiki/Themes.md)

[Patreon](https://www.patreon.com/jekithemonkey)

Expand Down
File renamed without changes
Binary file added Wiki/Previews/celestial-blue-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added Wiki/Previews/modifications-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added Wiki/Previews/white-orange-2-preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions Wiki/Themes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# How to install

1. Close the program if it's opened
2. Download a theme and place it in any directory you want
3. Move **ONLY** the program file in the theme directory
4. Open the program

# How to make own theme

To make your own theme you have to provide textures and fonts which you should put in the same program directory. Then set asset name and its extension in the menu (Ctrl + A). If you want to change color, size, increase spacing or whatever you wish, you have look up the menu, where all the parameters are.

# Themes

These themes may be compatible only with the newest version, if you want to use an old program version then you should look up [here](https://www.dropbox.com/sh/198quwutazjbpza/AADUHDhlNqCA5mYhUh1D0GDZa?dl=0) for old themes.
Themes are in order from new to old (click the name to download)

# [Celestial blue](https://www.dropbox.com/sh/y2zk1t6r4up5lm4/AABYPECmQVpSBCNGgCWuUm_Ra?dl=1)
![](Previews/celestial-blue-preview.gif)

# [White-orange 2 with visualization](https://www.dropbox.com/sh/9nonxq681o9rrr6/AABdmxWozVlrleDkQ6O6PkT8a?dl=1)
![](Previews/white-orange-2-with-visualization.gif)

# [7k&4k mania white-orange 2](https://www.dropbox.com/sh/whkvbird34qbc7c/AADQbhes52j56_E2UAseeZ1ja?dl=1)
![](Previews/7k-4k-mania-white-orange-2-preview.gif)

# [7k mania white-orange 2](https://www.dropbox.com/sh/8h530utysuqszy7/AAD2b72y1F9WMKc_IqwyQeuIa?dl=1)
![](Previews/7k-mania-white-orange-2-preview.gif)

# [ADOFAI white-orange 2](https://www.dropbox.com/sh/o62t0r0c603cn0p/AADEYccFL6HlcSlJRCHnDInVa?dl=1)
![](Previews/adofai-white-orange-2-preview.gif)

# [White-orange 2](https://www.dropbox.com/sh/jzil6gmlok0mt8d/AACs17TOTEJdQc2RvoHN0ouEa?dl=1)
![](Previews/white-orange-2-preview.gif)

# [Red-violet](https://www.dropbox.com/sh/pmsxo61jsif8zum/AACBBLRm5YaIWuJYbkSMPjR4a?dl=1)
![](Previews/red-violet-preview.gif)

# [Dark minimalistic 2 nano](https://www.dropbox.com/sh/m1nddmxcui97v22/AACZw8PJL_RlM_HJjcmmg81Ka?dl=1)
![](Previews/dark-minimalistic-2-nano-preview.gif)

# [Dark minimalistic 2](https://www.dropbox.com/sh/thgf4yjiubkj8wg/AABT5hbL8FYXAMffmjS_taVNa?dl=1)
![](Previews/dark-minimalistic-2-preview.gif)

# [Dark minimalistic nano](https://www.dropbox.com/sh/1fus2hmx0xn4s4r/AACGesu7riyDYFL3oDxAil3Ua?dl=1)
![](Previews/dark-minimalistic-1-nano-preview.gif)

# [Dark minimalistic](https://www.dropbox.com/sh/iz8637rh7uc9e5v/AACWHes5YbG5NbIe2zXp8UfYa?dl=1)
![](Previews/dark-minimalistic-1-preview.gif)

# [Medieval](https://www.dropbox.com/sh/ezpe13l6hk5fyc1/AACzzbsbTBzTcbAa6d_XNwzoa?dl=1)
![](Previews/medieval-preview.gif)

# [Modern purple](https://www.dropbox.com/sh/n6zeuqkiuvx0xpw/AAD6tINJ74vpgFv8PGdXhslTa?dl=1)
![](Previews/modern-purple-preview.gif)

# [White-orange](https://www.dropbox.com/sh/mlc3jiedl21renv/AAAJ-w92Q5uF59-ZCq-5PyPEa?dl=1)
![](Previews/white-orange-1-preview.gif)

# [Dark-violet](https://www.dropbox.com/sh/miv1kmbir7ua5cb/AAAtHTxx8YiUu0CBAHtkaKKFa?dl=1)
![](Previews/dark-violet-preview.gif)

# [Dark classic](https://www.dropbox.com/sh/g1806zg7kifawuq/AABEIi6sPCSGpwgvmEIMXRABa?dl=1)
![](Previews/dark-classic-preview.gif)

0 comments on commit 4fc766f

Please sign in to comment.