curioustorvald/Terrarum
1
0
Fork 0
mirror of https://github.com/curioustorvald/Terrarum.git synced 2026-06-15 04:54:05 +09:00
Code Issues Packages Projects Releases Wiki Activity

Updated Keyboard Layout and IME (markdown)

CuriousTorvald
2022-09-18 22:40:00 +09:00
parent 4b191ca835
commit 487755947e
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Keyboard-Layout-and-IME.md

@@ -12,7 +12,7 @@ The layouts are stored in `<assets> or <module base dir>/keylayout/` directory a
**.key** files must be formatted as such: **.key** files must be formatted as such:
``` ```javascript
{ {
"n":"US-Intl. Qwerty", // the name of the layout "n":"US-Intl. Qwerty", // the name of the layout
"capslock":"caps", // the capslock mode "capslock":"caps", // the capslock mode
@@ -40,29 +40,29 @@ When an IME receives a key press, it can either *accept* or *reject* the key inp
**.ime** files must be formatted as such: **.ime** files must be formatted as such:
``` ```javascript
let states = { let states = {
"keylayouts": ..., // same format as the .key files' "t" key "keylayouts": ..., // same format as the .key files' "t" key
"code": 0, // used internally. Write 1 if the character is being composed, 0 if not "code": 0, // used internally. Write 1 if the character is being composed, 0 if not
"hasDeadKey": false, // if this keyboard layout has deadkeys "hasDeadKey": false, // if this keyboard layout has deadkeys
} // note: the states object is technically optional, but you *will* want to use it } // note: the states object is technically optional, but you *will* want to use it
return Object.freeze({ return Object.freeze({
"n":"두벌식 표준", // the name of the layout "n": "두벌식 표준", // the name of the layout
"v":"none", // candidate mode. "many" for layouts that require candidates (e.g. Chinese and Japanse), "none" if candidates are not required "v": "none", // candidate mode. "many" for layouts that require candidates (e.g. Chinese and Japanse), "none" if candidates are not required
"c":"CuriousTo\uA75Bvald", // the copyright string "c": "CuriousTo\uA75Bvald", // the copyright string
"m":"rewrite", // the operation mode. Use one of "rewrite" or "candidates" "m": "rewrite", // the operation mode. Use one of "rewrite" or "candidates"
"t":states.keylayouts.map(it => [it[0],it[1]]), // keyboard layout. Only used by the ingame config UI to show the layout info "t": states.keylayouts.map(it => [it[0],it[1]]), // keyboard layout. Only used by the ingame config UI to show the layout info
"l":"koKR", // the language associated with the layout "l": "koKR", // the language associated with the layout
"accept": (headkey, shiftin, altgrin) => { "accept": (headkey, shiftin, altgrin) => {
... /* more codes here */
return [arg, keysymbol] return [arg, keysymbol]
}, // a function that accepts a key input that returns an array }, // a function that accepts a key input that returns an array
"backspace": () => { "backspace": () => {
... /* more codes here */
return keysymbol return keysymbol
}, // a function that is called when the backspace key was down that returns a Key Symbol }, // a function that is called when the backspace key was down that returns a Key Symbol
"end": () => { "end": () => {
... /* more codes here */
return keysymbol return keysymbol
}, // a function that is called when a composing is being cancelled that returns a Key Symbol }, // a function that is called when a composing is being cancelled that returns a Key Symbol
"reset": () => { ... }, // a function that resets the IME's internal state "reset": () => { ... }, // a function that resets the IME's internal state