Skip to content

User guide

StuffzEZ (Aka Stuf_y) edited this page Aug 21, 2025 · 1 revision

Welcome to the KeyCL User Guide! Here you can learn how to use KeyCL. This page is currently updated for v1.1.0.

Opening KeyCL

Opening KeyCL is an essential part of KeyCL since it makes it work!

If you haven't ran it since installing and have the requirements

Please continue one you have read the install guide for your version. It should be on the releases page

  1. Run the script (eg. windows.bat, macos.sh or linux.sh)
  2. Select option 8

If it is in your start menu

  1. Search for it
  2. Open it

If it starts on startup

  1. Right click on the tray icon
  2. Press open KeyCL KeyCL is now open and there also should be a icon in your tray for it.

Home

On the home menu of KeyCL, there are multiple options. It should look like this.
image
You can use multiple buttons. You can use the Disable Sounds button to disable sounds from being played by KeyCL. You can use the Open Sounds Folder button to open the location of the sounds. You can use the Test Current Sound button the hear what you current sound sounds like. The Home menu also shows you what the active sound is and what the volume is.

Sound library

The sound library is where you browse your various sounds and can install them. It looks like this with multiple sounds installed.
image
You can Select a sound to use it or test it to see what it sounds like. There is a refresh sound list button to refresh it incase you need to because you added some sounds and they arent showing up. There is also a Browse Online Sound Library button to browse our online sound library for sounds that we have uploaded. You can also install from a keyclsound file if you have one locally that you want to test. It will show you what sound you are using because it will have a music note next to it to show.

Settings

The settings menu can be used to configure KeyCL. It looks like this.
image
You can configure the volume to adjust how loud the sounds are with the volume slider. By default, it is 50%. This will not affect your PC's volume. You can also change your theme. You can choose system, if you want it to match your system theme, dark, if you want dark mode, or light. You can also reset all settings to default.

About

This page shows you credits, copyright and information about KeyCL. It looks like this.
image
It currently doesn't do anything other than display text and currently, due to a bug the version number is incorrect.

Sidebar

You can navigate between pages by clicking on the button for it on the sidebar. The sidebar looks like this.
image
You can also view the status of the sound on the sidebar with the indicator below the title. It will be green or red.

Viewing logs

To view logs, download LogLauncher, put it in the KeyCL directory and run it. Choose main.pyw.