{"id":21059698,"url":"https://github.com/zthxxx/midk","last_synced_at":"2025-05-16T00:33:52.414Z","repository":{"id":37181084,"uuid":"244830039","full_name":"zthxxx/midk","owner":"zthxxx","description":"Mapping MIDI keypress to PC keyboard, that you can work or code with your MIDI kerboard 🎉","archived":false,"fork":false,"pushed_at":"2023-03-07T12:05:39.000Z","size":8834,"stargazers_count":5,"open_issues_count":12,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-21T03:43:14.386Z","etag":null,"topics":["keyboard","keyboard-layout","midi","midi-keyboard","portal"],"latest_commit_sha":null,"homepage":"https://midk.zthxxx.me","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zthxxx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-04T06:59:01.000Z","updated_at":"2024-01-19T18:17:53.000Z","dependencies_parsed_at":"2023-02-18T14:45:27.025Z","dependency_job_id":null,"html_url":"https://github.com/zthxxx/midk","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fmidk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fmidk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fmidk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zthxxx%2Fmidk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zthxxx","download_url":"https://codeload.github.com/zthxxx/midk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254447868,"owners_count":22072754,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["keyboard","keyboard-layout","midi","midi-keyboard","portal"],"created_at":"2024-11-19T17:12:43.005Z","updated_at":"2025-05-16T00:33:47.396Z","avatar_url":"https://github.com/zthxxx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e🎹 MIDK \u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/zthxxx/midk\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://travis-ci.org/zthxxx/midk.svg\" alt=\"Build Status\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/midk\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/npm/v/midk\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/midk\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/npm/dt/midk\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://nodejs.org/\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/npm/node/midk\" alt=\"Node.js\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zthxxx/midk/blob/master/LICENSE\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/github/license/zthxxx/midk\" alt=\"License\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\nMapping MIDI keypress to PC keyboard, that you can work or code with your MIDI kerboard 🎉\n\n(e.g. this project is code in midk)\n\n[![midk-portal](./images/midk-portal-2580x600.png)](https://midk.zthxxx.me)\n\n\n## Install \u0026 Usage\n\n```bash\nnpm i -g midk\n\nmidk\n```\n\n## Dev \u0026 Debug\n\nlaunch midk portal and watching files change\n\n```bash\nnpm start\n```\n\nvisual the keys-mapping like the above preview image, preview in https://midk.zthxxx.me\n\n```bash\nnpm run cheatsheet\n```\n\n## Customization\n\nyou can customize keys-mapping in config file `~/.midk/midk.yml` (created after install).\n\nthe default config is stored in [`src/portal.ts`](./src/portal.ts)\n\n```yaml\n# choose a pitch notation which is used for note names in config\n# https://en.wikipedia.org/wiki/Helmholtz_pitch_notation\n# https://en.wikipedia.org/wiki/Scientific_pitch_notation\npitchNotation: Scientific  # Scientific | Helmholtz\n\n# if enable playMode, stop to control keyboard\nplayMode:\n  # default enable when start\n  enable: false\n  # composite keys to toggle enable/disable playMode\n  toggle:\n    - CSharp2\n    - DSharp2\n    - ASharp5\n\n# all supported key names are written in `keyboard.ts`\n# https://github.com/zthxxx/midk/blob/master/src/keyboard.ts\n#\n# interface Portal {\n#   [NoteName]: KeyName\n# }\nportal:\n  CSharp2: escape\n  FSharp2: tab\n  G2: control\n  GSharp2: capsLock\n  A2: alt\n  ASharp2: shift\n  B2: command\n\n  C3: a\n  CSharp3: q\n  D3: z\n  DSharp3: w\n  E3: s\n  F3: x\n\n  ...\n\n# when press the Fn-key, alter some keys mapping\n#\n# interface FnPortal {\n#   [NoteName]: Portal\n# }\nfnPortal:\n  C2:\n    CSharp3: f1\n    D3: f2\n    DSharp3: f3\n    E3: f4\n    F3: f5\n\n    ...\n```\n\n## License\n\n[MIT LICENSE](./LICENSE)\n\n\n## Author\n\n**midk** © [zthxxx](https://github.com/zthxxx), Released under the **[MIT](./LICENSE)** License.\u003cbr\u003e\n\n\u003e Blog [@zthxxx](https://blog.zthxxx.me) · GitHub [@zthxxx](https://github.com/zthxxx)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzthxxx%2Fmidk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzthxxx%2Fmidk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzthxxx%2Fmidk/lists"}