bms-clipboarder

Make BMS faster with BMS clipboard scripts

1. Introduction

BMS Clipboard Scripts are small programs that operate on clipboard data of a BMS editor. Combined with AutoHotKey, you can create BMS notecharts faster.

Note: These scripts only work with iBMSC. Pull requests to make it work with BMSE is welcome.

2. Included Tools

2.1 Ctrl M move notes

This tool lets you move selected notes easily by typing the desired key sequence.

2.2 Ctrl B bgmize

This tool moves notes back to BGM columns. It can be useful for creating 差分BMS (custom charts).

2.3 Ctrl D unmatch notes

This tool is to be used with BMS Sound Matcher. It copies the notes from BGM columns into “keysound reference” in player’s columns.

You can safely move the resulting notes around (horizontally), or delete them, without affecting original notes in the BGM channel. Finally, use BMS Sound Matcher to compile your BMS file into a playable version.

3. Requirements

• AutoHotKey
• iBMSC 3.0 Delta

4. Usage

1. Download the latest version of bms-clipboarder from the releases page.

2. Extract the ZIP archive, and double-click “BMS Clipboarder.ahk”

3. Make sure that LN Input Style - NoteTool is selected.

4. Drag to select notes.

5. Press the keyboard shortcut that corresponds to the desired tool (see Section 2 - Included Tools).

5. Technical Information

bms-clipboarder consists of two main parts:

1. bms-clipboarder shell (written in AutoHotKey)

2. Individual tools (written in Haskell, but possible to write using other languages)

5.1 bms-clipboarder shell

This is an AutoHotKey script that listens to hotkeys. When the key is pressed, firstly, it sends Ctrl+X/Ctrl+C key to copy/paste notes. Secondly, it invokes an individual tool, sending the data from clipboard. Lastly, it copies the result from the individual tool into clipboard and sends Ctrl+V key to paste notes.

You can change the keyboard shortcut AND÷OR add more tools by editing BMS Clipboarder.ahk file.

5.2 Individual tools

This is a command-line program that reads BMS clipboard data from Standard Input, and return resulting clipboard data to Standard Output.

Although these tools are written in Haskell, you can create extra tools in any language. You only need to make sure that it obeys the input/output format.

Haskell is chosen because:

• It can be compiled into .exe files very easily.
• It has a very smart type system, which means shorter code.
• It has a strong type system, which helps makes less bug-prone code.

Input Format

• Input format is the clipboard data from BMS editor (right now, it only supports iBMSC).

Output Format

• First line: Must be "ok" or "error", indicating the result.

• Second line: Success or error message.

• Subsequent lines: Modified clipboard data.

Example

Given the following input.txt

iBMSC Clipboard Data xNT
9 0 8720000 0 0
8 24 8730000 0 0
9 48 8740000 0 0
10 60 8750000 0 0
9 84 8760000 0 0
10 108 8770000 0 0
11 132 8780000 36 0
8 192 8790000 0 0
8 216 8800000 0 0
8 240 8810000 0 0
10 252 8820000 0 0
11 276 8830000 0 0

When run the following command:

dist\build\BGMize\BGMize.exe < input.txt

It will print out:

ok
Moved notes!
iBMSC Clipboard Data xNT
26 276 8830000 0 0
26 252 8820000 0 0
26 240 8810000 0 0
26 216 8800000 0 0
26 192 8790000 0 0
26 132 8780000 0 0
26 108 8770000 0 0
26 84 8760000 0 0
26 60 8750000 0 0
26 48 8740000 0 0
26 24 8730000 0 0
26 0 8720000 0 0

6. Development

To work on individual tools, you need to install Haskell Platform. To compile the source codes into .exe files, run:

cabal build