An open API service indexing awesome lists of open source software.

https://github.com/junekelly/carpalx-macos

Carpalx keyboard layouts for macos, including "option keys" supporting the full range of special characters on macOS.
https://github.com/junekelly/carpalx-macos

carpalx carpalx-keyboard-layouts keyboard-layout mac macos osx

Last synced: about 16 hours ago
JSON representation

Carpalx keyboard layouts for macos, including "option keys" supporting the full range of special characters on macOS.

Awesome Lists containing this project

README

          

# Carpalx MacOS

[Carpalx](https://mk.bcgsc.ca/carpalx/) keyboard layouts for macOS, including
"option keys" supporting the full range of special characters on macOS.

![Screenshot of the QGMLWY layout](_assets/lead-screenshot.png)

## Layouts

- [Fully Optimised](https://mk.bcgsc.ca/carpalx/?full_optimization)
- (C1) **QFMLWY**
- (C2) **QGMLWB**
- (C3) **QGMLWY**
- [Partially Optimised](https://mk.bcgsc.ca/carpalx/?partial_optimization)
- (C4) **QWKRFY**
- (C5) **QWYRFM**
- [Community
Layouts](https://mk.bcgsc.ca/carpalx/?partial_optimization#carpalxq_user_contribution)
- (C6) **CarpalxQ** (by [Jay
Walker](http://jumpedthesynapse.blogspot.com/2007/07/carpalxq.html))
- (C7) **QGPR** (by [Jameson
Quinn](https://sourceforge.net/p/qwpr/wiki/Home/))

## Installation Instructions

1. Download this repository, by clicking the green "Code" button above and
choosing either a `git`-based option, or choosing the zip file.

![Download the repository](_assets/install-download.png)

2. Copy the `Carpalx.bundle` file to either `~/Library/Keyboard Layouts/`, or
to `/Library/Keyboard Layouts/`

![Copy the bundle](_assets/install-copy-bundle.png)

3. (You may need to restart your computer at this point)

4. Open the System Settings app

5. Open "Keyboard" settings

6. Under the "Text Input" heading, click "Edit"

![Edit button under Text Input](_assets/install-text-input-edit.png)

7. Click the "+" button in the lower-left

![Plus button](_assets/install-plus-button.png)

8. (At this point, the Carpalx bundle should have been loaded) Select the
Carpalx layout you'd like to add (All layouts in this bundle start with
"CX"), and click "Add"

![Layout list](_assets/install-layout-list.png)

9. Click "Done"

10. In the menu bar, you should see the input source menu, where you can select the
keyboard layout you'd like to use.

![Input source menu](_assets/install-input-source-menu.png)

(Caveat: I personally use QGMLWY, so the other layouts are a blind-spot for me.
If you have any problems with the layouts, please open an issue on this
repository!)

## Why?

I've been using the [Carpalx layouts from
deekan](https://github.com/deekayen/carpalx_mac) for a long time, but I noticed
that those layouts don't have "option keys", the special characters that are
available on macOS keyboard layouts by holding the Option key. Because of this,
it's not possible to type special characters or access the "dead keys" required
to add accented characters like you can on a normal keyboard layout.

## How These Layouts Were Made

I made these layouts with the [Ukelele](https://software.sil.org/ukelele/)
keyboard editor app, starting from the default Colemak layout and then swapping
keys until I had the desired layouts. By doing it this way, all the "special
stuff" was preserved, and the resulting keyboard layouts fit in nicely with the
rest of macOS.

## The Layouts

### Fully Optimised

#### (C1) QFMLWY

Default:
![C1 QFMLWY Screenshot](_assets/c1-screenshot.png)

Holding "Option":
![C1 QFMLWY Screenshot, holding "Option"](_assets/c1-opt-screenshot.png)

#### (C2) QGMLWB

Default:
![C2 QGMLWB Screenshot](_assets/c2-screenshot.png)

Holding "Option":
![C2 QGMLWB Screenshot, holding "Option"](_assets/c2-opt-screenshot.png)

#### (C3) QGMLWY

Default:
![C3 QGMLWY Screenshot](_assets/c3-screenshot.png)

Holding "Option":
![C3 QGMLWY Screenshot, holding "Option"](_assets/c3-opt-screenshot.png)

### Partially Optimised

#### (C4) QWKRFY

Default:
![C4 QWKRFY Screenshot](_assets/c4-screenshot.png)

Holding "Option":
![C4 QWKRFY Screenshot, holding "Option"](_assets/c4-opt-screenshot.png)

#### (C5) QWYRFM

Default:
![C5 QWYRFM Screenshot](_assets/c5-screenshot.png)

Holding "Option":
![C5 QWYRFM Screenshot, holding "Option"](_assets/c5-opt-screenshot.png)

### Community-Contributed Layouts

#### (C6) CarpalxQ

Default:
![C6 CarpalxQ Screenshot](_assets/c6-screenshot.png)

Holding "Option":
![C6 CarpalxQ Screenshot, holding "Option"](_assets/c6-opt-screenshot.png)

#### (C7) QWPR

Default:
![C7 QWPR Screenshot](_assets/c7-screenshot.png)

Holding "Option":
![C7 QWPR Screenshot, holding "Option"](_assets/c7-opt-screenshot.png)

## License

See [LICENSE](./LICENSE)

## Guest Book

If you like this project, consider opening a pull request to add your name to
this list!

### Users, Fans, and Guests

- June Kelly ([@JuneKelly](https://github.com/JuneKelly)), original author of
Carpalx MacOS