Home

How to make a custom keyboard layout for CustomKey

Introduction

A custom keyboard layout for customkey is simply a json file that contains the keyboard configuration. For example this is the JSON file of the "QWERTY to JAP Keyboard" layout :

{
  "Name": "QWERTY to JAP Keyboard",

  "Key1_Char": "ろ",
  "Key1_ID": "VcBackQuote",
  "Key2_Char": "ぬ",
  "Key2_ID": "Vc1",
  "Key3_Char": "ふ",
  "Key3_ID": "Vc2",
  "Key4_Char": "あ",
  "Key4_ID": "Vc3",
  "Key5_Char": "う",
  "Key5_ID": "Vc4",
  "Key6_Char": "え",
  "Key6_ID": "Vc5",
  "Key7_Char": "お",
  "Key7_ID": "Vc6",
  "Key8_Char": "や",
  "Key8_ID": "Vc7",
  "Key9_Char": "ゆ",
  "Key9_ID": "Vc8",
  "Key10_Char": "よ",
  "Key10_ID": "Vc9",
  "Key11_Char": "わ",
  "Key11_ID": "Vc0",
  "Key12_Char": "ほ",
  "Key12_ID": "VcMinus",
  "Key13_Char": "へ",
  "Key13_ID": "VcEquals",
  "Key14_Char": "た",
  "Key14_ID": "VcQ",
  "Key15_Char": "て",
  "Key15_ID": "VcW",
  "Key16_Char": "い",
  "Key16_ID": "VcE",
  "Key17_Char": "す",
  "Key17_ID": "VcR",
  "Key18_Char": "か",
  "Key18_ID": "VcT",
  "Key19_Char": "ん",
  "Key19_ID": "VcY",
  "Key20_Char": "な",
  "Key20_ID": "VcU",
  "Key21_Char": "に",
  "Key21_ID": "VcI",
  "Key22_Char": "ら",
  "Key22_ID": "VcO",
  "Key23_Char": "せ",
  "Key23_ID": "VcP",
  "Key24_Char": "、",
  "Key24_ID": "VcOpenBracket",
  "Key25_Char": "￥",
  "Key25_ID": "VcCloseBracket",
  "Key26_Char": "む",
  "Key26_ID": "VcBackslash",
  "Key27_Char": "ち",
  "Key27_ID": "VcA",
  "Key28_Char": "と",
  "Key28_ID": "VcS",
  "Key29_Char": "し",
  "Key29_ID": "VcD",
  "Key30_Char": "は",
  "Key30_ID": "VcF",
  "Key31_Char": "き",
  "Key31_ID": "VcG",
  "Key32_Char": "く",
  "Key32_ID": "VcH",
  "Key33_Char": "ま",
  "Key33_ID": "VcJ",
  "Key34_Char": "の",
  "Key34_ID": "VcK",
  "Key35_Char": "り",
  "Key35_ID": "VcL",
  "Key36_Char": "れ",
  "Key36_ID": "VcSemicolon",
  "Key37_Char": "け",
  "Key37_ID": "VcQuote",
  "Key38_Char": "つ",
  "Key38_ID": "VcZ",
  "Key39_Char": "さ",
  "Key39_ID": "VcX",
  "Key40_Char": "そ",
  "Key40_ID": "VcC",
  "Key41_Char": "ひ",
  "Key41_ID": "VcV",
  "Key42_Char": "こ",
  "Key42_ID": "VcB",
  "Key43_Char": "み",
  "Key43_ID": "VcN",
  "Key44_Char": "も",
  "Key44_ID": "VcM",
  "Key45_Char": "ね",
  "Key45_ID": "VcComma",
  "Key46_Char": "る",
  "Key46_ID": "VcPeriod",
  "Key47_Char": "め",
  "Key47_ID": "VcSlash",

  "Shift1_Char": "ロ",
  "Shift2_Char": "ヌ",
  "Shift3_Char": "フ",
  "Shift4_Char": "ア",
  "Shift5_Char": "ウ",
  "Shift6_Char": "エ",
  "Shift7_Char": "オ",
  "Shift8_Char": "ヤ",
  "Shift9_Char": "ユ",
  "Shift10_Char": "ヨ",
  "Shift11_Char": "ワ",
  "Shift12_Char": "ホ",
  "Shift14_Char": "タ",
  "Shift15_Char": "テ",
  "Shift16_Char": "イ",
  "Shift17_Char": "ス",
  "Shift18_Char": "カ",
  "Shift19_Char": "ン",
  "Shift20_Char": "ナ",
  "Shift21_Char": "ニ",
  "Shift22_Char": "ラ",
  "Shift23_Char": "セ",
  "Shift24_Char": "゛",
  "Shift25_Char": "゜",
  "Shift26_Char": "ム",
  "Shift27_Char": "チ",
  "Shift28_Char": "ト",
  "Shift29_Char": "シ",
  "Shift30_Char": "ハ",
  "Shift31_Char": "キ",
  "Shift32_Char": "ク",
  "Shift33_Char": "マ",
  "Shift34_Char": "ノ",
  "Shift35_Char": "リ",
  "Shift36_Char": "レ",
  "Shift37_Char": "ケ",
  "Shift38_Char": "ツ",
  "Shift39_Char": "サ",
  "Shift40_Char": "ソ",
  "Shift41_Char": "ヒ",
  "Shift42_Char": "コ",
  "Shift43_Char": "ミ",
  "Shift44_Char": "モ",
  "Shift45_Char": "ネ",
  "Shift46_Char": "ル",
  "Shift47_Char": "メ"
}

Configuration

In the line :

• "Name": "QWERTY to JAP Keyboard" : "QWERTY to JAP Keyboard" is the value of the key "Name" that appears in the layout drop-down list (ComboBox).

• "Key1_Char": "ろ" : "ろ" is the value of Key1_Char which corresponds on which character/value to be assigned to key number 1. The KeyID of CustomKey can be displayed with the KeyID layout which is include by default in the application.

• "Key1_ID": "VcBackQuote" : "VcBackQuote" is the KeyID of your keyboard. You can get the ID of a key in the layout window accessible by going to Settings --> (Temporary) Open Key ID getter, then focus the opened window and press a key. The ID of the key supported by CustomKey should be displayed. You can easily copy this ID using the "Copy Key ID" button.

Short Example :

(TO DO)