Skip to content

README_EN.md

Latest commit

 

History

History
123 lines (81 loc) · 5.89 KB

README_EN.md

File metadata and controls

123 lines (81 loc) · 5.89 KB

Этот файл также доступен на русском языке.

wellum-description

Wellum — keyboard layout for 34/36 Keys

wellum-preview

Table of Contents

About the Firmware

The firmware/layout is designed for use with Universal Layout — a system layout for Windows, Linux, and macOS. On the project page, you can find all necessary instructions for installing and modifying this layout.

The firmware/layout is based on callum.

The firmware/qmk version runs on QMK and is intended for wired keyboards.
The firmware/zmk version runs on ZMK and is intended for wireless keyboards.

Terms

  • Modifier: Shift, Ctrl, Alt, or Gui
  • Layer Keys: SYM, NAV, ALT, CMD
  • Language Switch: LANG on the base layer (or on the NAV layer for the 34-key version)

The LANG key is essentially a Caps Lock key. In the Universal Layout system layout, Caps Lock switches between internal EN and RU layers. At the same time, no system language/layout switching occurs!

Layouts

Number of Keys Layout
34 Wellum 34
36 Wellum 36

How One-shot Sticky Modifiers Work

When holding layer keys, pressed modifiers are added to the queue and remain pressed until a non-modifier key or a layer key is pressed.

For example, to press the Windows Gui key without any combinations, you need to:

  • Hold the layer key
  • Press the modifier Gui
  • Release the layer key and tap it again.

And if you need, for example, to press the combination Ctrl+Shift+T, you have several options:

  1. First:
    • You hold the layer key SYM
    • Type the modifiers K (Ctrl) and J (Shift) in any order
    • Release the layer key SYM
    • Press T
  2. Second:
    • You hold the layer key NAV
    • Type the modifiers D (Ctrl) and F (Shift) in any order
    • Release the layer key NAV
    • Press T

As soon as T is pressed, the modifier queue will trigger, clear, and input the combination Ctrl+Shift+T will be sent to the system.

Moreover, by holding the modifier keys but releasing the layer key, the modifiers will remain held, allowing you to use them in combinations with keys from the other half.

In the ZMK version, the following is also implemented: upon pressing a modifier key again, it immediately triggers and is not added to the queue. This, for example, allows calling the Start Menu with just NAV+A+A, which turns into LGui.

How Swapper and Tabber Work

The Swapper NAV+W and Tabber NAV+Q keys are special macros for Alt+Tab and Ctrl+Tab respectively. However, when pressed, they leave the Alt and Ctrl modifiers held until layer key is held.

Thus, by repeatedly pressing W and Q, you can switch between windows in Windows, tabs in a web browser or terminal.

These keys are compatible with the Shift modifier, which allows inverting the switching direction for windows/tabs.

How to Install?

Everything depends on your keyboard. If you don't know where to start, study the instruction on how to adapt the layout to your keyboard?

For some keyboards, firmware builds exist (may be added by users via Pull Requests). You can search for your keyboard in the prebuilts folder.

QMK

To build the firmware, you will need the current version of QMK.

  • Copy the contents of the firmware folder to <your_keyboard>/keymaps/wellum
  • Build and flash using the standard build/flash command for your keyboard, specifying the :wellum variant.
  • If LAYOUT_split_3x5_2 or LAYOUT_split_3x5_3 are not defined in info.json for your keyboard, you need to make them yourself, following this instruction.

ZMK

To build the firmware, you will need a GitHub account. You can take a repository for your keyboard as a basis or this repository with a dongle, and then adapt it by applying the contents of the firmware/zmk/wellum36 folder (or wellum34 for the 34-key version).

Changelog

v3.1.1

  • Added English readme and guides.

v3.1

  • Fixed bugs and comments (thanks @pravets)
  • QMK and ZMK firmware brought to a unified form
  • Updated layout images

v3.0

  • Added version for wireless keyboards on ZMK firmware
  • Positions of W and S keys returned to original, as they performed poorly in games.
  • For ZMK, Bluetooth device control keys added to the game layer GFN.

v2.0

  • Added layout for 34 keys.
  • Added CMD layer containing media keys and macros.
  • ALT layer separated into a separate layer on the keyboard, providing greater customizability of this layer.
  • On the game layer, positions of W and S keys changed for more ergonomic finger positioning.

v1.0

  • First release