Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.37 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.37 KB

kb-bindings-ui

A graphical interface for configuring kb-bindings or game-shell using dat-gui.

screenshot

To try the demo run npm start or visit http://deathcap.github.io/kb-bindings-ui/.

Usage

var createBindingsUI = require('kb-bindings-ui');

createBindingsUI(null, {
    kb: kb, // kb-bindings instance to control
    gui: gui, // datgui instance to add to (optional; created if not given)
    hideKeys: [], // array of vkeys to not show in list (optional)
})

Like voxel-plugins-ui and voxel-debug, you can pass an existing datgui instance to add to an existing dialog window instead of creating a new one. Optionally, kb-bindings-ui can be loaded through voxel-plugins, and it will load after voxel-debug and voxel-plugins-ui, reusing their datgui instance.

The key names shown come from the vkey module (note, not all platforms may support all keys).

In the GUI you can change the key for each binding. The changes take effect immediately.

License

MIT