https://github.com/rukai/rukaibox_firmware
A firmware for hitbox controllers, supporting the GRAM slim and other RP2040 based controllers with the same pinout.
https://github.com/rukai/rukaibox_firmware
Last synced: 3 months ago
JSON representation
A firmware for hitbox controllers, supporting the GRAM slim and other RP2040 based controllers with the same pinout.
- Host: GitHub
- URL: https://github.com/rukai/rukaibox_firmware
- Owner: rukai
- License: mit
- Created: 2025-01-27T09:59:10.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-21T13:40:11.000Z (4 months ago)
- Last Synced: 2025-03-05T21:02:41.879Z (4 months ago)
- Language: Rust
- Homepage:
- Size: 85 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# Rukaibox
A firmware for hitbox controllers, supporting the GRAM slim and other RP2040 based controllers with the same pinout.
[joybus-pio](https://github.com/JonnyHaystack/joybus-pio) and [haybox](https://github.com/JonnyHaystack/HayBox) were heavily referenced in the implementation.
## Goals
### Currently implemented
* Should support any RP204 board with the standard pinout. (currently only tested on the [GRAM slim PCB](https://gramctrl.com/products/gram-slim-pcb))
* Supports gamecube (joybus) controller protocol.
* Implementation in rust makes it easier to tweak, build and flash changes
* Firmware level profiles for Project+ and Rivals 2
* KDL config file allows configuring per profile key remapping, SOCD mode etc.
### Things I plan to implement
* Cleanup the config file format
* Move kdl_config project into its own repo
* Move off rust nightly by helping move cargo bindep feature towards stabilization
### Things I would be happy for others to implement
* Profiles for other platform fighter games
* N64 support
* HID controller support
* HID keyboard support
## Non-Goals
* Support for non RP2040/pico boards
* If boards start using the RP2350 chip, or the RP2040 is in some other way seriously outdated I will consider moving to a new chip.
* Profiles for non platform fighter games
* Keep these in your own fork
## How to flash
1. Bring your controller's PCB into flashing (bootsel) mode. On the GRAM this is done by holding down the start button while plugging it in via USB C <-> USB A cable.
2. Download executable from latest github [Releases](https://github.com/rukai/rukaibox_firmware/releases)
3. Modify config.kdl in a text editor to set key maps etc. (Optional)
4. Run downloaded flashing executable
On windows you must have winusb installed via [zadig](https://zadig.akeo.ie/), if you use a GC adapter in wii U / switch mode you have already done this.
## How to flash a custom version
1. First install [rustup](https://rustup.rs/)
2. `git clone https://github.com/rukai/rukaibox_firmware`
3. Make any changes to the firmware in `rukaibox_firmware/rukaibox_firmware`
4. Make any changes to the config in config.kdl.
5. Bring your controller's PCB into flashing (bootsel) mode. On the GRAM this is done by holding down the start button while plugging it in via USB C <-> USB A cable.
6. `cargo run --release -p rukaibox_flash`
On windows you must have winusb installed via [zadig](https://zadig.akeo.ie/), if you use a GC adapter in wii U / switch mode you have already done this.