Skip to content

Commit

Permalink
renames workflow and adds build badge
Browse files Browse the repository at this point in the history
  • Loading branch information
TheNotary committed Sep 12, 2024
1 parent 550b2a4 commit 92ca477
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
File renamed without changes.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# XVX S-K80 Keyboard Driver for LED Control

> Warning: One keeb was lost during the development of this driver. XVX S-K80 and company (Womier seems to be an alternate name) does not ship with a very robust firmware and has open vulnerabilities that allow any non-root program on your computer to permenently destroy the device. If your computer emmits the wrong packets to the keyboard, it could actually brick the device. While this repo should be safe for S-K80's produced between 2023 and 2024, but knowing the issues with firmware released by this company, I recommend using this repo (and their official drivers for that matter) only if you're willing to accept the risk of losing the device.
[![windows](https://github.com/TheNotary/keyboard_driver_sk80/actions/workflows/windows.yml/badge.svg)](https://github.com/TheNotary/keyboard_driver_sk80/actions/workflows/windows.yml)

This project builds `blink.dll` a userspace driver that can control the LEDs on an XVX S-K80 mechanical keyboard. It happens to also support the RK84 by Royal Kludge.
> Warning: One keeb was lost during the development of this driver. XVX S-K80 and company (Womier seems to be an alternate name) does not ship with a very robust firmware and has open vulnerabilities that allow any non-root program on your computer to permenently destroy the device. If your computer emmits the wrong packets to the keyboard, it could actually brick the device. While this repo should be safe for S-K80's produced between 2023 and 2024, but knowing the issues with firmware released by this company, I recommend using this repo (and their official drivers for that matter) only if you're willing to accept the risk of losing the device.
This project builds `blink.dll` a userspace driver that can control the LEDs on an XVX S-K80 mechanical keyboard. It happens to also support the RK84 by Royal Kludge.
To communicate with the keyboard, this project leverages the Windows API, meaning it shouldn't require any installation to be run on a windows machine, but also won't work for linux. Please leave either a note or a PR if you'd like linux supported.


Expand Down

0 comments on commit 92ca477

Please sign in to comment.