Skip to content

snolab/CapsLockX

CapsLockX - 💻 Get Hacker's Keyboard. Operate your computer like a hacker

CapsLockX is a modular hotkey script engine based on AutoHotkey. It allows you to operate your computer efficiently like a hacker in a movie without ever taking your hands off the keyboard. It comes packed with functions that are intuitive and easy to use: enhanced editing, virtual desktop and window management, mouse simulation, in-app hotkey enhancement, JS mathematical expression calculation, and many more multifunctional features are there for you to personally customize.

Docs in Languages: English Docs (ChatGPT Translated) 简体中文 説明

See Any Language Docs (Google Translated)


CapsLockX is a modular hotkey script engine based on AutoHotkey. It makes it so you can effortlessly operate your computer with high efficiency like a hacker from the movies, without taking your hands off the keyboard. There are a lot of easy-to-learn and very user-friendly functions available: editing enhancement, virtual desktop and window management, mouse simulation, application-specific hotkey enhancement, JS mathematical expression calculation, and many other features await your personal customization. Main repository address 🏠: https://github.com/snolab/CapsLockX


Version Wall - Badges Wall 📛 Badges

Chinese Programming, 996.icu GitHub license GitHub top language GitHub commit activity GitHub stars

GitHub release (latest by date) gh-pages GitHub all releases jsdelivr_GITHUB

npm npm publish npm jsDelivr hits (npm)

Chocolatey version Chocolatey Publish Chocolatey Downloads


Beginner's Quick Start Tutorial 📖 Tutorial

Simple Quick Start Tutorial (Completion of this section is considered the beginning of mastering CapsLockX)

CapsLockX has four core functions: window management, mouse emulation, arrow key emulation, and application-specific hotkeys. This beginner tutorial will teach you the first three core functions.

First, get CapsLockX: download this zip file: Download JSDelivrCDN - Release Package.zip

After unzipping, open CapsLockX.exe within the CapsLockX folder, get past the simple beginner tutorial, and then try out the following functions in the left and right-hand feature areas to understand the capabilities of CapsLockX.

Once CapsLockX is started, it will not affect the functionality of other keys on your keyboard. The following features are triggered only when you press CapsLockX + combination keys.

Left-hand feature area:

  • Window management: CapsLockX + 1234567890 switches to the nth virtual desktop, CapsLockX + ZXCV for window operations (window switching, window closing, window arranging, transparency top-most).
  • Mouse emulation function: Press CapsLockX + WASD to move the mouse (as simple as moving a character while playing a game), press CapsLockX + QE for left and right mouse clicks, CapsLockX + RF for scrolling up and down.

Right-hand feature area:

  • Arrow key emulation: Open any text editor (such as Notepad), press HJKL to move the cursor, YOUI to move the page

After familiarizing yourself with the basic features, consult the quick reference guide below for more advanced functionalities.


Advanced Reference Manual 🦽 Manual

Installation and Use 🛠 Installation

Portable Program Package (for beginners, stable version) 📦 Packaged Bins

The source code package is the software itself, no need to compile, just unzip and use the green portable software. Source code + program package, the first one is recommended (the fastest).

  1. Download JSDelivrCDN - Release Package.zip
  2. Alternative Download CloudFlareCDN - Release Package.zip
  3. Alternative Download GitHub - Release Package.zip
  4. Alternative Download GitHub - Repository Program Package.zip
  5. Alternative Download BitBucket - Repository Program Package.zip
  6. Alternative Download for Mainland China Users - Gitee - Repository Program Package.zip (login required)

You can use it after unzipping. Methods to start and set to auto-start: Double-click CapsLockX.exe to start the script. To add a startup item, enter shell:startup in the start menu - run, then create a shortcut for this program, and throw it in.

Command Line Installation (recommended for advanced users, can be updated automatically) 🖥️ Install by command

Choose any of the following, the 4th one is recommended for users in mainland China

  1. npx capslockx@latest, -- Directly run with NPX, always run the latest version, recommended (requires installation of NodeJS)
  2. choco update capslockx && capslockx -- Use Chocolatey to install and use cup for automatic updates, recommended
  3. npm i -g capslockx && npx capslockx -- npm global installation
  4. git clone https://gitee.com/snomiao/CapslockX && .\CapsLockX\CapsLockX.exe -- Mainland China source code package (green software package) unzip and use, recommended for mainland China users
  5. git clone https://github.com/snolab/CapsLockX && .\CapsLockX\CapsLockX.exe -- GitHub source code package (green software package) unzip and use
  6. winget capslockx -- TODO #40
  7. scoop capslockx -- TODO #41

User Manual 📖 - Usage Manual

Basic Operations

  • Hold down CapsLockX to enter CapsLockX mode, at which point your keyboard will become a functional keyboard like the default mode of Vim (see key positions below).
  • Press CapsLockX+Space at the same time to lock CLX mode, where CLX will be maintained until CapsLockX is pressed again next time. Origin of Function

Module Description

CapsLockX by default loads some commonly used modules. The features and how to use them are listed below. If you don't need certain modules, you can also directly delete the .ahk files in the ./Modules directory, and then press Ctrl + Alt + \ to reload.

You can also write your own my-ahk.user.ahk and put it in the ./User/ directory, and CapsLockX will automatically recognize and load them.

Nightmares of Multitasking

Virtual Desktop Overview: Scenario Modes, Work Desks, Entertainment Desks, Project Categories...

Typically, a set of tasks a user is currently performing will include multiple windows. These windows combined can constitute a usage scenario, while multiple scenarios are likely to run at the same time, and some of them will run for a long time, without interference. This will involve a lot of window arrangement and virtual desktop switching operations, in these aspects, using CLX to manage your windows will bring a terrifying efficiency improvement.

Below are some examples of scenario combinations: Suppose you can study, work on several different jobs, chat with friends, play games, listen to BGM in the background, and have a paused movie ready to watch with family in the evening.

  • Virtual desktop 1: Planning scenario: Schedule window + Multi-platform sync notes, e.g.: Google Calendar + Notion + Gmail.
  • Virtual desktop 2: Learning scenario: Book reading window, note-taking window, e.g.: OneNote + Calibre, etc.
  • Virtual desktop 3: Work scenario 1 (Front-end Development): Code editing + Documentation querying + Browser, e.g.: Chrome(dev) + VSCode + stackoverflow, etc.
  • Virtual desktop 4: Work scenario 2 (Back-end Development): Code editing + Documentation querying + Backend terminal + Database browser, e.g.: DBeaver + VSCode(+bash) + stackoverflow, etc.
  • Virtual desktop 5: Work scenario 3 (Script Development): Code editing + Documentation querying + Script target, e.g.: VSCode(+bash) + stackoverflow etc.
  • Virtual desktop 6: Work scenario 4 (3D Modeling and Rendering): 3D modeling software + Material searching, e.g.: Blender + Chrome.
  • Virtual desktop 7: Work scenario 5 (3D Printing Slicing): Slicing software + Model searching window, e.g.: Cura + thingiverse
  • Virtual desktop 7: Work scenario 6 (Video Processing): Editing + Material management, e.g.: PR + Everything.
  • Virtual desktop 7: Work scenario 7 (Video Processing): Post-production + Documentation tutorial, e.g.: AE + Chrome.
  • Virtual desktop 8: Writing scenario: Writing window, material referencing window, e.g.: Obsidian + Chrome (Google Scholar Index), etc.
  • Virtual desktop 9: Communication scenario 1: Casual chats, e.g.: Telegram + Reddit + .
  • Virtual desktop 9: Communication scenario 2: Work communication, e.g.: Slack + Skype + Gmail.
  • Virtual desktop 9: Communication scenario 3: Presentation, e.g.: Google Meeting + (Vscode | Page application | Requirements document | Feedback document).
  • Virtual desktop 0: Entertainment scenario 1: Playing games, e.g.: Age of Empires, Minecraft, Skyrim, Overcooked 2, etc.
  • Virtual desktop 0: Entertainment scenario 3: Watching movies, listening to songs, e.g.: PotPlayer, Youtube Music, etc...
  • ... More examples are welcome. Provide Issues or PRs for supplementation.

Snowstar does not recommend you handle too many tasks at the same time, but CapsLockX can save your thinking environment, greatly reducing the mental cost you incur during task switching, that is, saving you a lot of time rearranging windows and the resulting loss of attention.

(Note: If you like to handle many tasks at the same time, you might need not only a computer with not a small amount of memory but also a brain of significant capacity :D )

Enhancing the User Experience of Windows Window Switching - Win+Tab

When switching windows with Alt+Tab, if there are too many windows, a two-dimensional window pre-arrangement display will show up. Generally speaking, Alt+Tab and Alt+Shift+Tab are purely left-handed keystrokes. If the user wants to select the window in the next line, they will instinctively press Alt+Tab many times. However, the directional keys used for two-dimensional operations are often ignored because the right hand is usually on the mouse or on the J key.

Also, users will continue to hold down the Alt key after releasing the Tab key to browse the windows and select the target window to switch to. In CLX, Alt+WASD will be used instead of the arrow keys to perform multiline window switching directly with the left hand, so there is no need to press Shift to go back to the left. Moreover, if a user needs to clean up or close multiple windows, they simply press Alt+X to batch clean multiple target windows while remaining within the window browsing interface.

In CLX, these features greatly improve the usability of Alt+Tab.

TODO-Docs

Click to expand TODO-docs

Focus count: Active window, default active window, …

Each desktop has only one active focus window, and the virtual desktop can achieve automatic switching to the focus window of that virtual desktop when switching to it, achieving multiple task focuses (i.e., active windows).

Utilizing Multiple Screens - Multi-screening

Window Arrangement in the Era of 4K - Window arrange with 4k screen

Default window arrangement limitations in Windows 10:

  1. Not applicable to multiple desktops.
  2. Unnecessary window gaps are too large.
Window Management on Linux and Mac - Window Manager in Linux and mac

TODO: i3 Window Management

Window Management on Android and iOS - Window Manage in android

Two system-level solutions: Left-right top-bottom split screen, floating windows; Application level: floating components,

Troubles with Editing Operations

The Distance Between the Typing Area and Editing Control Area

TODO Discussion on ThinkPad and Mac arrow keys, inspiration from VIM,

Human Perception of Speed

TODO: World perception of exponential growth, focus, auditory, visual, tactile, VS conventional linear operations

Troubles with the Graphical User Interface

TODO: Document: Introduction to mouse simulation function, movement in RPG games

Shortcut Deficiencies in Software

TODO: Application enhancement module introduction

The Usability of Portable Keyboards

TODO: FN key, arrow keys, editing operations, 61-key layout vs 87-key layout,

The Concept of Chording

TODO Various types of chording TODO Calculation of information quantity increase with chording

Module Helps

Help Module

If you want to learn how to develop plugins for CapsLockX, please:

  1. Open Modules/@Help.ahk, where you can find the basic format of a CapsLockX plugin.
  2. Make a copy of it and rename it to your own plugin name.
  3. Change its original features to the features you need, and your plugin development is done!

Below are the functions of this module

Applies to Hotkey Function
Global CapsLockX + / Temporarily show hotkey tips
Global CapsLockX + Alt + / 🔗 Open the full documentation page for CapsLockX
Global CapsLockX + Shift + / 🕷 Submit

Help Module

If you want to learn how to develop plugins for CapsLockX, please:

  1. Open Modules/@Help.ahk, where you can find the basic format of a CapsLockX plugin.
  2. Make a copy of it and rename it to your own plugin name.
  3. Change its original features to the features you need, and your plugin development is done!

Below are the functions of this module

Applies to Hotkey Function
Global CapsLockX + / Temporarily show hotkey tips
Global CapsLockX + Alt + / 🔗 Open the full documentation page for CapsLockX
Global CapsLockX + Shift + / 🕷 Submit

Enhancements for OneNote 2016 - 2019

Enhance keyboard operations for OneNote 2016 - 2019, conveniently use the keyboard to: change pens, create links, organize pages, adjust views...

Snowstar Cat's Frequently Used Functions

  1. When making a journal entry, first add a date tag to the note's title with Alt + T (for future search), then use Win + Shift + N globally to search for all notes with today's tag in OneNote, conveniently retrieving your today's: romance journal, training log, daily

iFlytek Input Method Floating Window Plugin

Usage

Applied to Key Combination Description
Global Win + Alt + H Start/Switch iFlytek Voice Input

Note

  1. If iFlytek Voice is not installed, it will automatically prompt to guide the download and installation.

The effect is as shown in the image below

![App-iFlytek Voice Input Method Floating Window Demo.gif](./docs/media/App-iFlytek Voice Input Method Floating Window Demo.gif)

CLX - Brainstorm

Use AI-assisted input at any time, in any input box, by pressing CLX+b.

Key Bindings (Under Development)

Key Description Function Notes
CLX + b Copy selected content automatically, get AI support
CLX + Alt + b Configure activation code (Currently free plan)
CLX + Shift + b Check usage quota

Protips:

Organize Meeting Records Anytime
  1. Use Win+H to activate voice input inside any text box, and speak out what you want—it doesn’t have to be precise.
  2. Then select all and press CLX+b, type List key points and tasks, and AI will organize it for you.
Translate Any Language to Any Language

Enhanced Editing Plugin (TG YUIO HJKL) 🌟

Is there anything better than Vim's HJKL for moving the cursor? Absolutely a must-have! That's the smooth editing experience with acceleration-powered HJKL! Ever wanted to try a high-end maneuver where your cursor drifts around a corner like it's channeling water? Install this!

EditorCursorMovement.gif

Scope Edit Module Description
Global(Basic) CapsLockX + h j k l

Surface Notebook Function Key Expansion

A remedy for all kinds of broken notebook keyboards

  1. No right Ctrl key? Combine the Menu and Right Ctrl key – the Menu can act as Ctrl, or Ctrl can act as Menu.
  2. No Pause key? Win + Alt + P can also open the system settings info.
  3. To be added
Mode Keys Function
Global Win + Alt + P Equivalent to Win + Pause, specially for laptops
Global Tap Right Ctrl It will tap the Menu key to pop up the menu
Global Hold Right Menu Will hold Ctrl, allowing combinations with other keys
Win Key Emulation Hold ], press [ Equivalent to pressing the Win key
Win Key Emulation RAlt + | is equivalent to Alt+

Media Keys Module

Applies to Media Keys Module Description
Global CapsLockX + F1 Open: My Computer
Global CapsLockX + F2 Open: Calculator
Global CapsLockX + F3 Open: Web Browser Homepage
Global CapsLockX + F4 Open: Media Library (defaults to Windows Media Player)
Global CapsLockX + F5 Playback: Play/Pause

| Global

Mouse Simulation Plugin (WASD QERF)

I've always prided myself as a keyboard warrior, which probably started from the time I hurt my finger joints while modeling. I became a heavy user of the keyboard. Using various keyboard acceleration tools, actively memorizing various shortcut keys to minimize mouse usage, and even learning vim and emacs. However, there are many times when the mouse is irreplaceable, especially in the age of graphic interfaces.

—— The above is a passage from the author of SimClick Simulated Click, a work that simulates mouse clicks with a grid subdivision approach, and can complement this project.

—— Recommended by Jinwei Qin

Features

  • This module uses the key area: CapsLockX + QWER ASDF
  • Use

JavaScript Calculation (NodeJS installation recommended)

Applies to Shortcut Key Effect
Global CapsLockX + - Calculate the selected JavaScript expression and replace it
Global CapsLockX + = Calculate the selected JavaScript expression and replace it

Window Enhancement Plugin (CLX + 1234567890 ZXCV)

Feature Overview

Make good use of Windows 10’s own 10 virtual desktops with premium setup, automatic window arrangement for multi-monitors, translucent window pinning on top. (Note: Taskbar and AltTab related functions are currently incompatible with Win11, but window arrangement features work fine.)

  1. Window Switching: CapsLockX + [Shift] + Z
  2. Window Closing: CapsLockX + [Shift] + X
  3. Window Arrangement: CapsLockX + [Shift] + C
  4. Window Pinning: CapsLockX + [Shift] + V
  5. Left-Hand Window Management: WASD for window switching and X to close windows in the Alt + Tab interface.
  6. Efficient Virtual Desktop Usage: CapsLockX + 0123456789

Quick Input

Mode Shortcut Input Description
Global #D# Date input: (20220217)
Global #T# Time input: (20220217.220717)
Global #DT# Date and time input: 2022-02-17 22:07:33
Global #NPW# Random input of numeric password like: 7500331260229288
Global #PW# Random input of alphanumeric password like: yyCTCNYodECTLr2h
Global #WPW# Random input of alphanumeric password like: FtD5BB1m5H98eY7Y
Global `#SPW

Pomodoro Timer

A fixed 25-minute cycle for work with rest reminder.

Use CapsLockX + , to open the configuration, then change EnableScheduleTasks=1 to enable this plugin.

  • Use pomodoro time announcement (Play a work bell sound at 00 and 30 minutes, and a rest bell sound at 25 and 55 minutes of every hour) (Scheduled tasks need to be enabled first)

    UseTomatoLife=1
  • When using pomodoro announcement, automatically switch desktops (During pomodoro announcement, the rest desktop is 1, and the work desktop is 2)

    UseTomatoLifeSwitchVirtualDesktop=1

Note: If you only need the sound notification without the desktop switching, you might want to try this Chrome extension Tomato Life - Chrome Web Store

Further note: This plugin has been separated into an independent project. If you like the Pomodoro Technique, you can check out xuestar's tomato-life project here: [snom

Auto Screen Off When Locking

When pressing Win + L to lock the screen, the monitor turns off immediately. This is useful for preparing to sleep by turning off the computer screen so it doesn't hurt your eyes while sleeping... When pressing Win + Alt + L the monitor turns off immediately. This is useful for preparing to sleep by turning off the computer screen so it doesn't hurt your eyes while sleeping...

Past and Future 🛰

Production Background (Autumn of 2017) 🍁 Background

I often write code… At first, I was used to using the mouse with my right hand... later I found it a bit far to put the mouse on the right... so I switched to using the mouse with my left hand. After switching to the left hand, I realized I still had to take it off the keyboard... so I made a script that simulates the mouse with the WASD keys. (Then I could keep playing with the computer with my right hand under my chin) Later I wrote more and more scripts and put some of the common ones together to load...

Development RoadMap 🛰️ RoadMap

The core philosophy of CapsLockX is to simplify system operation logic, improve operation efficiency, and not conflict with existing habitual key positions.

  1. Press CapsLockX + - key to display corresponding help (the current display style is quite rough)
  2. i18n (eh this really should exist)
  3. Auto-update (although git pull is also fine)
  4. Tutorial for first-time users (this is a bit simple now...)
  5. Plugin manager (although the file system could handle it too)
  6. Auto-sync of configuration (though throwing it in OneDrive is usually enough)
  7. A user-friendly options configuration UI (though changing ini isn't that hard)
  8. Execute external code (Python, Nodejs, external AHK, Bash, …) (although running a script isn't much trouble)

If you have any ideas or suggestions, please propose them here: Issues · snomiao/CapslockX

Key Combination Meaning Design ⌨ Chore Design

Win + series are generally used for operating system functions, desktop window application process management, input method, output device (display, multiple screens) management.

Alt + series typically denote invocation of application internal functions, their meanings should be equivalent to pressing the same function button, or jumping to a specific function interface.

Ctrl + series as above, but used more frequently and it's very likely that there is no button with the same function.

Ctrl + Alt + same as above, but generally for global hotkeys.

The Shift key is used to slightly change the meaning of the above functions (such as reverse operations like Shift+Alt+Tab, or extended function range like Shift+Arrow keys to adjust the selection, etc.)

Compares

CapsLockX vs. Similar Projects Function Comparison ⚔ Feat Compare Matrix

Updated (20200627) The information may become outdated over time

Feature\Project CapsLockX Vonng/CapsLock coralsw/CapsEz CapsLock+
Mouse Simulation ✅ Smooth and complete ✅ No scroll wheel 🈚 None 🈚 None
Expression Calculation ✅ Nodejs or JScript 🈚 None 🈚 None ✅ TabScript (Snippet + Javascript)
Window Management ✅ Strong ✅ Available ✅ Available ✅ Strong
Virtual Desktop Management ✅ Available 🈚 None 🈚 None 🈚 None
Editing Enhancement ✅ Available (parabolic model) ✅ Available ✅ Available ✅ Very comprehensive
Portable (No Install) ✅ Yes ✅ Yes ✅ Yes ✅ Yes
Enhanced Media Keys Not all ✅ All 🈚 None 🈚 None
Enhanced Clipboard Weak 🈚 None 🈚 None ✅ Available
Quick Application Launch ✅ Plugins ✅ Available ✅ Available ✅ Available
Application Feature Enhancement ✅ Rich 🈚 None ✅ Available 🈚 None
Bash Control 🈚 None ✅ Available 🈚 None 🈚 None
Quick Start Voice Input ✅ iFLYTEK 🈚 None 🈚 None 🈚 None
Quick Input of Time and Date ✅ Available ✅ Available
Bind Window to Hotkey 🈚 None 🈚 None 🈚 None ✅ Available
Quick Screen Rotation ✅ Available 🈚 None 🈚 None 🈚 None
Secondary Development ✅ Documentation friendly ✅ Possible ✅ Possible ✅ Possible
Memory Usage ✅ About 2~3M
Modularization 🈚 None 🈚 None 🈚 None
System Win Mac (main), Win (secondary) Win Win, Mac
Supported Languages English / Chinese / Any Language (by ChatGPT) Chinese / English Chinese Chinese / English

CapsLockX Address 🔗 Project Urls

The following repositories are updated synchronously:

Document Address 📄

Star Chart ⭐️

  • Stargazers over time

Similar Project Addresses 🔗 Similar Projects

Questions and Answers ❓ Questions

Related Communities:

For questions related to CapsLockX, you can directly join the group @雪星 or ask privately.

Privacy and Security 🔒 Privacy

Considering that any software that can obtain administrative rights is quite dangerous to a user's operating system, CapsLockX must and is currently adopting an open-source approach. This allows the community to freely and arbitrarily inspect any part of the CapsLockX code that may be involved, to ensure that the security of all users' operating systems is not compromised by this software.

Support ⭐️ Supports

How to help CapsLockX survive? If CapsLockX has been helpful to you:

  1. ⭐️ Please star CapsLockX on Github Star
  2. 🔗 Please share it with your friends.
  3. 🌐 Welcome to help translate this documentation into different languages.
  4. 🐞 Welcome to submit bugs and suggestions for improvement issues
  5. Code PR submissions are welcome, even just to correct a typo ~
  6. Welcome to create works about this software, such as recording tutorial videos to post on Youtube or Bilibili, Xue Xing will like your video.
  7. 💰 Welcome to donate to the development of CapsLockX, each donation will be recorded in the list below:

Donation Records (as of 20210821) 📄 Donate Records

Donation Date Name Channel Amount Comment
2021-06-19 **Yu Alipay QR +50.00 CNY A little support, in favor of independent developers
2023-05-12 Karawen WeChat Transfer +200.00 CNY 🫡 (Salute)
2023-06-09 @andriasw Alipay Transfer +66.66 CNY for CapsLockX-mac, 66.66 is good (https://github.com/andriasw)
2023-12-19 Huidan QQ Red Packet +45.00 CNY Buy the developer a coffee

Acknowledgements 🙏🏻 Thanks

Related Topics for References

Footer Catalog - Table of Contents


<script async defer src="https://buttons.github.io/buttons.js"></script>