More information in README
Mockband / build (push) Has been cancelled Details

This commit is contained in:
Neale Pickett 2024-01-15 09:05:47 -07:00
parent 8e8836956d
commit 8c8549d47b
1 changed files with 33 additions and 8 deletions

View File

@ -1,4 +1,9 @@
# Mock Band ---
gitea: none
include_toc: true
---
# Introduction
Microcontroller Firmware to emulate guitar and drum kit controllers from the Microcontroller Firmware to emulate guitar and drum kit controllers from the
Wii version of the Rock Band games. Wii version of the Rock Band games.
@ -66,10 +71,30 @@ I'm sorry I didn't photograph or record any of this,
but it was pretty straightforward. but it was pretty straightforward.
# Compiling # Building
This compiles in the Arduino IDE. This will compile in the Arduino IDE,
It doesn't have any library dependencies. or on the commandline using `make`.
## Command Line
Just run `make` on a Unix system.
I set up paths for my Debian install of Arduino 1.8;
you may need to adjust them if your setup has different paths.
There is a `flash-%` target that will upload the built firmware to a Pro Micro.
The following targets exist:
make flash-guitar # Guitar firmware
make flash-guitar-wammy # Guitar firmware with wammy bar
make flash-drums # Drums firmware
## Arduino
Mockband has no library dependencies,
and as far as I can tell,
will work with the built-in Leonardo profile,
even though you're uploading to a Pro Micro.
You need to make two edits to `boards.txt`. You need to make two edits to `boards.txt`.
Instructions for this are all over the place. Instructions for this are all over the place.
@ -80,7 +105,7 @@ Don't edit anything that doesn't say `build` on the line! I can't help you if yo
In my examples, I'm editing the lines for the leonardo build. Yours might be different: In my examples, I'm editing the lines for the leonardo build. Yours might be different:
it should match the board you're using. it should match the board you're using.
## Build flags ### Build flags
This disables serial communications on the board. This disables serial communications on the board.
@ -89,7 +114,7 @@ This disables serial communications on the board.
Hat tip to Nicholas Angle for figuring this out Hat tip to Nicholas Angle for figuring this out
so I didn't have to. so I didn't have to.
## VID and PID ### VID and PID
These set the USB identifiers. These set the USB identifiers.
VID is the Vendor ID, VID is the Vendor ID,
@ -98,7 +123,7 @@ and PID is the Product ID.
`0x1bad` means "Harmonix Music", `0x1bad` means "Harmonix Music",
at least, it does to the Linux kernel. at least, it does to the Linux kernel.
### For guitar #### For guitar
PID `0x004` means "Guitar controller". PID `0x004` means "Guitar controller".
@ -107,7 +132,7 @@ PID `0x004` means "Guitar controller".
leonardo.build.usb_product="Mockband Guitar" leonardo.build.usb_product="Mockband Guitar"
### For drums #### For drums
PID `0x3110` means "Rock Band 2 drums". PID `0x3110` means "Rock Band 2 drums".
This works better with all versions of Rock Band on my wii, This works better with all versions of Rock Band on my wii,