Log inGet started
Package

rhythmChart.assetType

Newest version

README.md

rhythmChart (asset type)

A rhythm game note chart: one song at one difficulty. The asset is a folder <name>.rhythmChart/ holding chart.txt (the chart), a README.md saying which song and difficulty it is, and .metadata.

chart.txt is the Downbeat chart format, written by hand:

title: Neon Drive
audio: neonDrive          # the soundClip the chart is timed to
difficulty: hard
lanes: 4
bpm: 124                  # tempo at beat 0
offset: 0.250             # seconds of audio before beat 0
tempo 128 132             # from beat 128 the tempo is 132 bpm

8      1                  # <beat> <lane>
8.5    2+3                # a chord
9      4   hold 2         # a hold note two beats long
@4:3   1                  # bar 4, beat 3 (1-based)
bar 5: x... .x.. ..x. ...x     # a bar grid: one row per step, one character per lane
bar 6: h... .... .... e...     # h starts a hold, e ends it, x is a tap, . is empty

Load it in game code:

local Chart = require("downbeat.chart")
local chart = Chart.fromAsset(asset.resolve("neonDrive_hard", "rhythmChart"))

Chart.parse(text) returns (chart, problems); every problem names its line, the text on it and what is wrong ("line 14: lane 5 is outside 1-4"). The full format is in the downbeat package README, "Chart format".