{"id":13622842,"url":"https://github.com/crsnbrt/keysim","last_synced_at":"2025-04-15T10:31:46.646Z","repository":{"id":37110994,"uuid":"294258257","full_name":"crsnbrt/keysim","owner":"crsnbrt","description":"design and test virtual 3d keyboards.","archived":false,"fork":false,"pushed_at":"2023-11-29T12:07:06.000Z","size":10585,"stargazers_count":842,"open_issues_count":37,"forks_count":101,"subscribers_count":16,"default_branch":"develop","last_synced_at":"2024-08-01T21:55:12.042Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://keyboardsimulator.xyz/","language":"JavaScript","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/crsnbrt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-09-10T00:10:36.000Z","updated_at":"2024-07-27T03:40:11.000Z","dependencies_parsed_at":"2023-02-06T09:15:33.299Z","dependency_job_id":"b01751c3-39f2-486f-8aeb-897fcc3b6cec","html_url":"https://github.com/crsnbrt/keysim","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crsnbrt%2Fkeysim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crsnbrt%2Fkeysim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crsnbrt%2Fkeysim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crsnbrt%2Fkeysim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crsnbrt","download_url":"https://codeload.github.com/crsnbrt/keysim/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223668475,"owners_count":17182933,"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":[],"created_at":"2024-08-01T21:01:24.836Z","updated_at":"2024-11-08T10:31:13.737Z","avatar_url":"https://github.com/crsnbrt.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# KeySim\r\n\r\nhttps://keyboardsimulator.xyz/\r\n\r\ndesign and test virtual 3d keyboards.\r\n\r\n## getting started\r\n\r\n```\r\nnvm use\r\nnpm install\r\nnpm start\r\n```\r\n\r\n## contributing\r\n\r\n**colorways:** Any PR's for new colorways will be accepted as long as there is a real physical version of that colorway, or an ongoing group buy.\r\n\r\n**layouts:** The goal of this project is not to recreate every possible keyboard layout, therefore I have no plans to add any new layouts myself. However PR's for new layouts will be accepted as long as they are not too similar to current layouts.\r\n\r\n## adding new colorways\r\n\r\nrun the command `npm run create-colorway COLORWAY_ID \"COLORWAY_NAME\"` to create the file: `/src/config/colorways/colorway_COLORWAY_ID`. Edit this file directly or paste json from the advanced section of the editor tab.\r\n\r\n## A note on three.js version\r\n\r\nThis project was built before the [depreciation](https://discourse.threejs.org/t/three-geometry-will-be-removed-from-core-with-r125/22401) of `THREE.Geometry` there are currently no plans to update three past version 125 as this would require a rewrite of the case and key geometry to support BufferGeometry.\r\n\r\n## configuration\r\n\r\njson configuration for layouts and keymaps are based on [qmk](https://beta.docs.qmk.fm/). keymaps can be changed by switching the corresponding [keycodes](https://beta.docs.qmk.fm/using-qmk/simple-keycodes/keycodes).\r\n\r\n_NOTE: Special keys from keyboards with custom firmware (e.g. [layer switching](https://beta.docs.qmk.fm/using-qmk/software-features/feature_layers)) may not trigger keydown events, as these are not [supported](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values) in javascript_\r\n\r\n## screenshots\r\n\r\n![alt example image](./public/example-1.jpg?raw=true)\r\n\r\n![alt example image](./public/example-2.jpg?raw=true)\r\n\r\n![alt example image](./public/example-3.jpg?raw=true)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrsnbrt%2Fkeysim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrsnbrt%2Fkeysim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrsnbrt%2Fkeysim/lists"}