Editor support

Editor plugins and other tools for allowing BQN input are in this folder. Input is always performed with a backslash \ prefix by default, using the layout shown here. To type an actual backslash, hit the backslash key twice.

This bookmarklet enables BQN input in any webpage in your browser.

This userscript highlights BQN code on GitHub.

For Android, this fork adds APL and BQN to Hacker's Keyboard.

For macOS, a keyboard layout can be found here.

The file inputrc can be copied or appended to ~/.inputrc to enable backslash input in bash, BQN with rlwrap, and other software that uses GNU Readline.

If you'd like to contribute files for another editor I'd gladly accept them!

System-wide

XKB (Unix)

The file bqn is for configuring XKB on Linux, or other systems using X11. To use, copy it to /usr/share/X11/xkb/symbols/, then run

$ setxkbmap -layout us,bqn -option grp:switch

replacing us with your ordinary keyboard layout. switch indicates the right alt key and can be replaced with lswitch for left alt or other codes. The setting will go away on shutdown so you will probably want to configure it to run every time you start up. The way to do this depends on your desktop environment. For further discussion, see Wikipedia or the APL Wiki.

Another XKB option, if you have a compose key enabled, is to place XCompose (possibly with adjustments) in ~/.XCompose.

Windows

Folder autohotkey-win contains an AutoHotKey script and the generated .exe file. It runs as an ordinary program that recognizes BQN key combinations system-wide, using the right alt key (to change this, replace RAlt in the script and rebuild). Move it to the startup folder if you'd like to have it running all the time. You can right-click its icon in the system tray to disable it temporarily.

The XCompose file, although created for XKB, is also usable with WinCompose.

Text editors

Vim

Copy or symlink all files into the corresponding directories in ~/.vim. Add the following two lines to ~/.vim/filetype.vim:

  au! BufRead,BufNewFile *.bqn setf bqn
  au! BufRead,BufNewFile * if getline(1) =~ '^#!.*bqn$' | setf bqn | endif

Include syntax on in your .vimrc for syntax highlighting and filetype plugin on for keyboard input.

To use vim-plug to install BQN support for vim, add this to your plugin section of your .vimrc:

  Plug 'mlochbaum/BQN', {'rtp': 'editors/vim'}

Then run :PlugInstall.

Emacs

Emacs support now lives on museoa/bqn-mode. Clone and add the following two lines to your init file (usually ~/.emacs.d/init.el), replacing the path appropriately.

(add-to-list 'load-path "/path/to/bqn-mode")
(require 'bqn-mode)

VS Code

See this repository.

Kakoune

Copy or symlink kak/autoload/filetype/bqn.kak into autoload/filetype in your Kakoune config directory (probably .config/kak/).