#keyboard #melee #slippi #boxx #ahk

app macboxx

A rust-based boxx-style keyboard mapper, designed for Slippi melee

6 releases

0.1.5 Aug 9, 2024
0.1.4 Apr 6, 2024

#560 in Command line utilities

24 downloads per month

MIT license

24KB
582 lines

Macboxx_rs

A hopefully more performant rewrite of macboxx.

Summary

A virtual controller to interact with slippi dolphin. !(https://github.com/agirardeau/b0xx-ahk)[boxx-ahk] runs only on windows and this would give support for boxx-y controller mappings to other platform users.

Installation

Install with cargo:

cargo install macboxx

Usage

macboxx -s <slippi path> -k <keymap path>

Where <slippi path> is the path to the slippi netplay directory. On MacOS, this is something like ~/Library/Application\ Support/com.project-slippi.dolphin/netplay, and <keymap path> is the path to the keymap.toml file. If you don't have one, one will be created for you in your home directory.

Keymap

keymap.toml should have the following format:

[buttons]
A = 'J'
B = 'O'
X = 'K'
Y = '/'
Z = 'I'
START = 'Return'
D_UP = 'UpArrow'
D_DOWN = 'DownArrow'
D_LEFT = 'LeftArrow'
D_RIGHT = 'RightArrow'

[control_stick]
UP = 'W'
DOWN = 'S'
LEFT = 'A'
RIGHT = 'D'

[c_stick]
UP = ';'
DOWN = ','
LEFT = 'N'
RIGHT = 'L'

[triggers]
L = 'Q'
R = ' ' 

[mods]
MOD_Y = 'ShiftLeft'
MOD_X = 'ShiftRight'

[mod_factors]
x = 0.5
down = 0.42
up = 0.4

(shoutout to lord's layout he shared on The Reads)

For non-alphanumeric keys, refer to the rdev Key enum. All other keys are uppercase letters, or the char they represent.

Dependencies

~2.7–4MB
~72K SLoC