Is my keyboard supported by sharkfin?

Plug it in and sharkfin says what it sees. Boards are identified from their own USB reply; most report vendor ID 3151 and some report their brand's own. The registry has 1384 boards, 1147 of them writable out of the box. A board that is not in the list, or whose command set is not on file, is read from its own answers, and the Setup page walks it to working.

Does sharkfin run on Mac or Linux?

Yes. The same app runs on Linux, Windows and macOS, and in a Chromium browser at app.getsharkfin.com with nothing to install.

Can sharkfin brick my keyboard?

sharkfin never flashes firmware. It writes settings. The worst known failure is the board ignoring USB until it is unplugged for ten seconds and plugged back in; typing keeps working the whole time.

Is my Attack Shark keyboard VIA or QMK compatible?

No. These boards run ROYUAN's own firmware, which does not speak the QMK or VIA protocol. sharkfin talks to the firmware the board already has and never replaces it.

How much does sharkfin cost?

Nothing. It is free software under GPL-3.0-or-later.

Does the browser version of sharkfin send my data anywhere?

No. It is a static page that makes no requests of its own once loaded, and there is no server that receives settings. Keymaps, macros and colours live on the keyboard and in the browser's local storage. The site carries no analytics script.

Is sharkfin made by Attack Shark?

No. It is a community project with no affiliation to Attack Shark, ROYUAN or any keyboard vendor.

GPL-3.0-or-later · 0.9.1, beta · Linux, Windows, macOS, browser

sharkfin

Open-source configurator for keyboards built on ROYUAN hardware: Attack Shark, Akko, Epomaker, MonsGeek, Ajazz, Hator, ikbc and others. Remap keys on a picture of the board, set the lighting, paint per-key colour, record macros, set the switches on magnetic boards, and back the settings up to a file. 1384 boards are in the registry.

Open in the browser Download

The browser build needs Chrome, Edge or another Chromium browser. Writes need a USB cable. Linux needs a one-line udev rule unless a package installed it. Beta: export a backup before rearranging things.

sharkfin keymap editor showing an Attack Shark X86 drawn key by key, in the Abyss colorway

sharkfin keymap editor showing an Attack Shark X86 drawn key by key, in the Olivia colorway

Features

Keys. Click a key on a picture of the board and give it another key, a mouse button, cursor movement, the scroll wheel, a macro or a media control. Base and Fn layers, and the knob. Each write lands on the keyboard at once.
Lighting. The effects the board's own firmware has, 18 on most boards, with direction, colour, brightness and speed. The effect runs on a picture of the board as you change it. A slider writes to the board when you let go of it. Edge-light controls appear where the board has edge LEDs.
Paint. Colour individual keys and send the pattern to the board. Sending is a separate click and is paced, because the pattern lands in the keyboard's flash.
Macros. Record key and mouse sequences with per-event delays into the 50 onboard slots, and bind a key to one on either layer: repeat, toggle, or while held.
Switches. On magnetic boards: actuation point, release point, rapid trigger, dead zone, dynamic keystroke, mod-tap, toggle and snap, per key or for every key. Writes are open where the firmware has been read, and Setup can open them for your board.
Device. Debounce, Windows-key lock, WASD and arrow swap, backlight off, host-OS auto-detect, sleep timers, factory reset, and a picture for the display on boards that have one.
Backup. Export keymaps, lighting and settings to a file and restore them later. Macros and per-key paint are not in the file. Profiles are stored on the board itself.
Setup. For a board sharkfin does not know: a few tests and questions that take it from read-only to working, with a report that can make it work for everyone. See Setup.

Supported boards

sharkfin talks to keyboards built on ROYUAN hardware. Most report USB vendor ID 3151; some ship under their brand's own. The board is identified from its own reply when plugged in, so you are never asked which model you have.

Boards in the registry	1384
Writable out of the box	1147
Command set asked of the board at connect, writable once you allow it	204
Drawn key by key out of the box	353
Drawn after a one-time confirmation against your board	818

A board with no drawn picture still works: you get a grid of key slots, or you can draw the board on the Keys tab. A board that is not in the list at all is read from its own answers, and the Setup page allows changes and checks them one by one. What "supported" means, state by state: Support.

Attack Shark Akko Epomaker MonsGeek Ajazz ROYUAN YUNZII GamaKay Skyloong KiiBoom Keydous MageGee Hator ikbc NOPPOO MEETION Royal Axe ABKO every brand

Safety and privacy

sharkfin writes settings, never firmware. Nothing to brick. If the board stops answering, unplug it for ten seconds. Safety
No write goes to a board whose command set is unknown. The board says which one it speaks.
The browser build makes no requests of its own once loaded and is handed the keyboard's settings channel, never its typing. No account, no analytics, no cookies. Privacy

Questions

Is my keyboard supported?

Plug it in and sharkfin says what it sees. The board list has one page per model with its USB ids and what sharkfin can do on it. A board that is not in the list is read from its own answers and set up from the Setup page.

I'm on Linux. Do I need a udev rule?

The .deb, .rpm and Arch packages install it. For the AppImage or the browser build, paste this into a terminal and replug the keyboard:

echo 'SUBSYSTEM=="hidraw", ATTRS{idVendor}=="3151|0461|046a|0db0|145f|14a5|2ea8|3121|3299|331a|374a|379a|38a9|38ee|391d|3984|39a8|39ab|54ab", MODE="0660", TAG+="uaccess"' \
  | sudo tee /etc/udev/rules.d/70-sharkfin.rules >/dev/null \
  && sudo udevadm control --reload-rules && sudo udevadm trigger

Writes one rule file and reloads udev.

Rules from VIA, Vial or a vendor package may already suffice. sharkfin shows the same command when it finds a keyboard it cannot open. More in Linux.

Do I need a cable?

For writes, yes. Over a 2.4 GHz receiver sharkfin reads whatever the receiver relays: some carry the settings channel, some carry nothing, and the same model ships with both, so there is no per-board answer. Plug the receiver in and the app says which yours is. Bluetooth has no settings channel. Settings are stored on the keyboard, so they keep working wirelessly afterwards.

Can it brick my keyboard?

It never flashes firmware. The worst known failure is the board ignoring USB until you replug it: close the app, unplug for ten seconds, plug back in. Typing keeps working the whole time.