Skip to content

Add your language: layout TOMLs and wordlists wanted #2

Description

@vstrelnikof

PolterType is data-driven: adding a language means writing one TOML file and one wordlist — no Rust required. The walkthrough is docs/ADDING_A_LANGUAGE.md.

Bundled today: EN · UK · RU · DE · ES · FR (data/layout-mappings/, data/wordlists/).

Languages people are likely to miss first (claim one in a comment, or just open a PR):

  • Polish (pl-PL)
  • Czech (cs-CZ)
  • Greek (el-GR)
  • Hebrew (he-IL)
  • Turkish (tr-TR)
  • Bulgarian (bg-BG)
  • Italian (it-IT)
  • Portuguese (pt-PT / pt-BR)
  • Your language — open a new-language issue and tell us what's special about it

Two paths:

  1. Try it locally first (no rebuild): drop <stem>.toml into <config-dir>/poltertype/layouts/ and a wordlist into <config-dir>/poltertype/wordlists/, restart, and watch the log for loaded user layout layout=… keys=….
  2. Upstream it: the bundled files are copy-paste templates; a PR with the TOML + wordlist (+ a line in the README language list) is all it takes.

Non-obvious bits worth reading in the doc before you start: dead keys are surfaced as their spacing equivalents, and the detector ignores scancodes you don't list — cover the alphanumeric block plus your language's word-boundary punctuation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions