configuration.md

Configuration

Files

• ~/.config/krabby
  • manifest.json: extension’s entry point.
  • config.js: contains the user configuration.
  • fetch: shell script to fetch plugins.
  • Makefile: contains commands to build and update Krabby.
  • packages: contains files used by Krabby: Modal, Prompt, Hint, Selection, Mouse, Clipboard, Scroll, Player, icons and krabby.js.
  • extensions: contains extensions used by Krabby: Commands, Shell and dmenu. Krabby repository can be found here, to update the extension when you run make update.

Krabby’s default configuration is located in ~/.config/krabby/packages/krabby.js.

Mapping

Creating and removing mappings boils down to the following commands:

modal.map(context, keys, command, description)

modal.unmap(context, keys)

The context dictates in what context the mapping will be available: Command, Text, Link, Image, Video or Page.

The keys represent a chord – a key sequence in which the keys are pressed at the same time. They are composed of a single key code and optional modifiers. For special keys, the list of key values can be found here.

The command is the function to evaluate.

The description is the description of the command.