Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crsnbrt/keysim
design and test virtual 3d keyboards.
https://github.com/crsnbrt/keysim
Last synced: about 1 month ago
JSON representation
design and test virtual 3d keyboards.
- Host: GitHub
- URL: https://github.com/crsnbrt/keysim
- Owner: crsnbrt
- License: mit
- Created: 2020-09-10T00:10:36.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-11-29T12:07:06.000Z (about 1 year ago)
- Last Synced: 2024-08-01T21:55:12.042Z (5 months ago)
- Language: JavaScript
- Homepage: https://keyboardsimulator.xyz/
- Size: 10.1 MB
- Stars: 842
- Watchers: 16
- Forks: 101
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- starred - crsnbrt/keysim - design and test virtual 3d keyboards. (JavaScript)
README
# KeySim
https://keyboardsimulator.xyz/
design and test virtual 3d keyboards.
## getting started
```
nvm use
npm install
npm start
```
## contributing
**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.
**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.
## adding new colorways
run 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.
## A note on three.js version
This 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.
## configuration
json 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).
_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_
## screenshots
