brd/README.md

BRD

BRD is a tool for working with Dance Dance Revolution related data. For currently supported features, see the Modes section.

Installation

Currently this is not published as a crate so you either have to clone the repository manually and run cargo build --release or you can use cargo install --git https://github.com/sbruder/brd to install the binary without cloning.

Modes

ddr2osu

This converts DDR step charts (.ssq files) and the corresponding audio (from .xwb files) to osu beatmaps (in an .osz container).

Basic usage:

brd ddr2osu -s file.ssq -x file.xwb -o file.osz --title "Song Title" --artist "Song Artist"
# use musicdb from DDR A
brd ddr2osu -s file.ssq -x file.xwb -o file.osz -m startup.arc

To learn more about supported options run brd ddr2osu --help

Known Problems

• Since osu!mania does not support shock arrows, it either ignores them or (by default) replaces them with a two-key combination (↑↓ or ←→); you can change this with the (--shock-action option)
• Known problems listed for unxwb (for wave banks without entry names having 2 entries, which often are preview and full song, the longest one is used by default).

ddr2osu-batch

This batch converts songs from a musicdb (and therefore currently only supports DDR A).

Basic usage (the ssq directory includes step charts and the xwb directory includes wave banks):

brd ddr2osu-batch -m startup.arc -o out -s ssq -x xwb --source "Dance Dance Revolution A"

Batch conversion for older versions is possible with the included shell script batch_convert.sh (usage guide at the top of the script).

unxwb

This can list and extract sounds from XWB wave banks.

Basic Usage:

brd unxwb file.xwb
brd unxwb -l file.xwb

unarc

This can list and extract files from DDR A ARC archives. It extracts the contents into the current directory.

Basic Usage:

brd unarc file.arc
brd unarc -l file.arc

musicdb

This lists all entries from musicdb.xml or startup.arc files (only DDR A is supported).

Known Problems

• It only supports sounds in ADPCM format. If you want to extract sounds that are stored in other formats, you can use Luigi Auriemma’s unxwb (Ctrl+F unxwb).
• For wave banks without name entries it does not yet offer the option to read the names from XSB files and currently generates the names from the index in the file (starting from 0).

About this project

This is my first rust project. Don’t expect too much from the code in terms of quality, robustness or idiomacity (especially regarding error handling). There currently are no tests for the actual functionality.

Large portions of this tool would not have been possible without the following resources:

• SaxxonPike’s scharfrichter which implements SSQ and XWB (1, 2) and their documentation about SSQ
• The official osu! file format documentation
• MonoGame’s XWB implementation
• Luigi Auriemma’s unxwb (especially the ADPCM header part)
• mon’s ddr_arc_extract

License

ISC License

This project is not affiliated with ppy or Konami.