Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gladuin committed Aug 12, 2022
1 parent f06c66b commit c4475ef
Showing 1 changed file with 3 additions and 33 deletions.
36 changes: 3 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Software that enables you to create your own Arduino based beatmania IIDX contro

# Features
- HID lighting support (that works with btools and ttools).
- Customisable sensitivity over HID for use with lightning mode or your own custom program (more on this further down).
- Different lighting modes (more info on this further down in the `Setup` section).
- GUI configuration tool.
- Multiple input methods (joystick, keyboard, mouse).

# Requirements
- An Arduino Leonardo (technically compatible with any ATmega32U4 based board, but only tested with a Leonardo).
Expand All @@ -26,40 +26,10 @@ Manufacturer name:
- By setting `MF_NAME` in `iidx-controller/config.h`, you can change the manufacturer name of your controller.
- You can change this to whatever you'd like, such as your name.

Spoof Konami official controller:
- Set `KONAMI_SPOOF` to `1` to spoof the manufacturer (thus also ignoring `MF_NAME`) and product name of the beatmania IIDX controller premium model.
- Useful for when you want to play beatmania Infinitas.

Increments per full turn:
- The value here sets the number of increments required to reach a full 360° turn.
- Set `INCREMENTS_PER_FULL_TURN` in `iidx-controller/config.h` to one of the values listed there.

Sensitivity:
- Recommended to leave disabled, since it interferes with the "Increments per full turn" setting.
- Enable by setting `NO_SENSITIVITY` to `0` in `iidx-controller/config.h`.
- More info in the `HID Sensitivity` section.

LED mode switching:
- Hold the last button in the button array, and then tap the first button in the button array to switch modes.
- The LED mode rotation is as follows:
1. HID / reactive auto (default setting, this switches to reactive mode if there are no LED HID messages in 3 seconds)
2. Reactive only
3. HID only
4. HID _and_ reactive

Info:
- Pinouts are available in `iidx-controller/config.h`, you can edit them there if necessary.
- Leonardo pinout (what the numbers in the codes pinout arrays mean) at the bottom of this page.

# HID Sensitivity
In spice, select `Beatmania IIDX` and go to the `Lights` tab. Scroll down until you see `Turntable P1 Resistance` and click the `Bind` button.
For `Device` select your Arduino, and for `Light Control` select `TT Sensitivity`.

![Spice setup](spicecfg.png)

You'll then be able to set the turntable sensitivity via the resistance menu on the subscreen in iidx >27 (with lightning mode enabled).

_NOTE: I haven't actually been able to test this, since I have a 60hz screen and can't boot into lightning mode. Please report any issues you encounter in the issues section._
- Additional settings can be configured via the GUI, more info [here](https://github.com/Gladuin/iidx-controller/tree/master/config-tool)

# Thanks
- Huge thanks to [CrazyRedMachine](https://github.com/CrazyRedMachine) for helping me out when I got stuck, and for their [SoundVoltexIO](https://github.com/CrazyRedMachine/SoundVoltexIO) repository.
Expand Down

0 comments on commit c4475ef

Please sign in to comment.