About this fork

This page describes what makes this guide different from the official CharaChorder documentation at https://docs.charachorder.com/, beyond the five-line note on the front page. It is maintained by Tangent Chang and is not affiliated with CharaChorder.

Generated setting tables

Tables that describe an individual setting – its default, its range or enum, which devices support it – are rendered from the CCOS Firmware Meta API rather than written by hand. This means their contents come directly from the firmware rather than from prose, so they can be more precise about per-device differences than the official guide, but they also inherit whatever the Meta API itself gets wrong or spells inconsistently.

A version picker

Every generated table on a settings page can be redrawn for a different CCOS release using the dropdown above it, since not every setting exists on every version. The list only includes releases that publish machine-readable settings data (2.1.0-rc.0 and later); older releases are not offered.

A generated release history

CCOS Releases is assembled the same way, from the Meta API’s changelog.json for CharaChorder One, Lite, X, Two, Engine, and Master Forge, merging entries that read identically across devices and flagging the ones that don’t. It only covers CCOS 2.1.0 and later: the Meta API no longer serves changelog data for older firmware versions. For the release currently in beta, see Beta Releases, which is still written by hand.

Content adopted from unmerged upstream pull requests

Some fixes and additions here started out as pull requests opened against the official documentation’s repository that have not been merged there. Each was checked against this fork’s current wording and, where relevant, against live-device behavior before being adopted, sometimes with corrections along the way. Most are small (typo fixes, broken cross-file link fixes, screenshot updates), but a few are larger, such as the Dynamic Library guide on Chords and the Chord Modifiers page split out of Device Manager. Pull requests whose content this fork already covered more accurately, or that no longer matched the current live UI, were left out.

Settings CCOS has since removed

A few settings the official guide still documents no longer exist in current firmware, and this fork’s generated tables cannot show a setting that is not in the Meta API. Mouse and keyboard poll rate, scan rate and keystroke delay, and the spurring settings and timeout, are all removed from CCOS 3.0.0 but still described upstream.

Sections moved between pages

The API groups a setting into does not say which menu or app a user actually reaches it from, so a few settings live on a different page here than they do upstream, based on checking where they actually appear: usb/poll rate and mouse/scroll throttle are documented under Device Manager here, and on the Generative Text Menu (GTM) page upstream.

Scope corrections

A handful of sections describe different hardware than the official guide. For example, the LED settings on the Device Manager page are no longer described as Lite-only, since the CharaChorder Master Forge also has them.

Presentation choices

The generated tables make a couple of small, deliberate choices that make their output differ from the hand-written original: enum values are kept in the Meta API’s lower case rather than capitalized, and single-letter unit labels on HSB (hue/saturation/brightness) settings are suppressed, since the API applies them inconsistently there.

A different theme, with dark mode

This fork uses the furo Sphinx theme instead of the official guide’s Read the Docs theme. Furo adds a light/dark/auto toggle in the top right of each page; auto follows your system’s color scheme, and your choice is remembered across visits.