Documentations for using this library?

[xxbidiao]

Hi, I'm looking for using this in a project, yet finding difficulties looking for what I need.

Are there any documentations / sample code for using them? Thanks!

[dtinth]

Hello, thanks for your interest!

API documentation is a bit lacking, but here’s a quick overview of usage:

1. Create a bms.BMSChart object using bms.Compiler

   const bmsSource = `#00101:01\n...`
   const compileResult = bms.Compiler.compile(bmsSource)
   const chart = compileResult.chart
   

   The BMSChart contains the raw BMS data (headers, objects, and timeSignatures) with minimal interpretation.

   Use chart.measureToBeat to convert (measure, fractionInsideMeasure) to beat number. This is important as most functions work on beat number.

2. To extract information from BMS, use the designated classes. These classes have a static method fromBMSChart that you can use.

   Information type	Extraction
   Timing data Handles BPM changes and stops Convert between beats and seconds	Timing.fromBMSChart(chart)
   Notes Interpret notes (both playable, and autoplay) Handles long notes	Notes.fromBMSChart(chart)
   SongInfo Interprets title, artist, level, …	SongInfo.fromBMSChart(chart)
   Keysounds Handles mapping from keysound ID to sound file	Keysounds.fromBMSChart(chart)
   Positioning Handles on-screen placement of notes Based on StepMania 5’s scroll segments See: Bemuse’s BMS extensions	Positioning.fromBMSChart(chart)
   Spacing Handles dynamic speed changes Based on StepMania 5’s speed segments Inspired from gimmicks in Pump It Up games See: Bemuse’s BMS extensions	Spacing.fromBMSChart(chart)

   To use these objects, I recommend trying playing with them in your JavaScript console!

Here are some resources that may help:

• An unfinished API docs. This lists the most important methods.
• List of dependents — you can see how other projects uses this library.
  • Snack-X/web-bms-viewer also uses this library.
• The tests for reading notes and timing data.
• The cucumber specs (bmspec) is implemented in the features directory.
  • This file (features/support/bms.js) shows how a test environment is setup.
  • Files in features/step_definitions implements the steps.

If you need specific help, feel free to ask. 😄