libkson

K-Shoot MANIA chart file (.ksh/.kson) parser library written in C++20

Status

• KSH file loading (compatible with 171)
• KSH file saving
• KSON file loading
• KSON file saving (compatible with 0.8.0)

KSH/KSON file format specification

See this repository: https://github.com/m4saka/ksm-chart-format-spec

Usage

Library

// Load KSH chart file
kson::ChartData chartData = kson::LoadKSHChartData("chart.ksh");

// Save KSON chart file
kson::SaveKSHChartData("chart.kson", chartData);

// Access to chart meta data
const std::string& title = chartData.meta.title;
const std::string& artist = chartData.meta.artist;

// Access to note data, convert pulses to seconds
const kson::TimingCache timingCache = kson::CreateTimingCache(chartData.beat);
for (int i = 0; i < kson::kNumBTLanes; ++i)
{
    for (const auto& [y, note] : chart.note.bt[i])
    {
        const double noteStartSec = kson::PulseToSec(y, chartData.beat, timingCache);
        const double noteEndSec = kson::PulseToSec(y + note.length, chartData.beat, timingCache);

        // ...
    }
}

Almost all variables are the same as in the KSON specification, but the following are different:

• Array types in KSON specification are stored as struct or map/set.
  • ByPulse<T>[] in KSON specification is stored as kson::ByPulse<T> (alias of std::map<kson::Pulse, T>).
• All unsigned numbers in KSON specification are stored as signed numbers.

ksh2kson tool

ksh2kson is a command line tool that converts KSH files to KSON files. Converted KSON files are saved in the same folder with the extension ".kson".

$ ./ksh2kson [KSH file(s)...]

Compilation

With Visual Studio 2022

Open kson.sln and click the build button.

With CMake

$ cmake -B build -D KSON_BUILD_TOOL_KSH2KSON=ON
$ cmake --build build

• For MSVC, the build type can be specified in the second command with --config Debug for debug builds and --config Release for release builds.

Dependency

• nlohmann/json (included in include/kson/third_party/nlohmann/json.hpp)
• iconv (Linux/macOS)

License

MIT License