Skip to content

An experimental fork of Optikey for programmer-specific features

License

Notifications You must be signed in to change notification settings

kmcnaught/OptikeyCoder

Repository files navigation

OptiKey Coder

This is an experimental fork of OptiKey with some features and ideas specific to users who want to write code.

There is a low bar to adding features/hacks in the interest of trialling different workflows and seeing what is most helpful. However, the stability this fork is not guaranteed - if you like a feature, open an issue to discuss whether it's appropriate for going back into the core Optikey app.

Core features we have experimented with so far:

  • Function keys to quickly switch between Presage prediction for prose (comments etc) and basic prediction for syntax
  • Swap between small language-specific dictionaries for syntax word prediction
  • Add words to dictionary temporarily (for this session) or permanently
  • Add words from clipboard to train Presage
  • Allow trigger gamepad button to be held down for repeat presses
  • A plugin to copy text to clipboard via a regex filter
  • Add larger SuggestionGrid for situations in which you want more suggestions visible

Keyboard features:

  • Reset prediction mid-word for snake_case, CamelCase variable names
  • Specific keyboard for VS Code, including lockable shortcut bar, snippets, navigation and more
  • Colour styling of keyboard to help find symbols

How to use our keyboards/settings

The full deployment relies on setting up a few different resources:

Keyboards

In Resources\Keyboards you will find the current XML keyboards. Set this as your starting folder in (Right click ->) Management Console -> Visuals -> Startup Keyboard and "Folder containing dynamic keyboards"

VS Code key bindings & snippets.

Several keys are hooked up to bespoke key bindings. You can find our keybindings in Resources\shared-settings\keybindings.json

The snippets references are in the snippets subfolder.

For these settings you can either copy-paste into your own respective files (e.g. Configure User Snippets and find the corresponding file) or you can set up a [symbolic link(https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/mklink) via windows command line to the appropriate location in %APPDATA%\Code\User

Main VS Code keyboard interface

Screenshot of Optikey Coder with main VS Code keyboard loaded

Navigation/selection keys for VS Code

Screenshot of Optikey Coder with VS Code's navigation keyboard loaded

About

An experimental fork of Optikey for programmer-specific features

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published