Table of Contents

    • Get keyboard layout file from ergogen

    published: 2026-04-11

    tags: ergogen,layout

    To obtain a keyboard layout file from Ergogen, you must first create a configuration file (typically a .yaml or .json file) that defines your keyboard’s geometry and key positions, then process it using the Ergogen tool.

    Running Ergogen Locally If you have Node.js installed, you can run the generator via the command line:

    npm i -g ergogen
ergogen input.yaml -o output_folder

    This command parses your input.yaml file and generates output files in the specified output_folder, including a points.yaml file which contains the raw coordinate data for the key matrix.

    Using the Web-Based Version For users without command line experience, the web-based tool at ergogen.xyz allows you to paste your configuration directly into the browser. This interface provides live previews and lets you download the generated output files immediately, including the points.yaml file needed for further processing.

    Converting to Standard Layout Formats The raw points.yaml file generated by Ergogen can be converted into a Keyboard Layout Editor (KLE) JSON file for easier visualization and editing. This is often done using the kbplacer Python package:

    python -m kbplacer.kle_serial -in points.yaml -inform ERGOGEN_INTERNAL -outform KLE_RAW -out layout.kle.json

    The resulting layout.kle.json file can then be imported into tools like the Keyboard Layout Editor or its re-implementation, Keyboard Layout Editor NG, for final layout adjustments and keymap definition.

    Sources