simai.js

simai.js

simai.js is an interpreter and serializer for simai, a custom chart format for the arcade rhythm game maimai, written in Typescript.

Getting Started

To use simai.js in your own project, install it via npm

pnpm add simai.js
yarn install simai.js
npm install simai.js

Then, use the following method to deserialize a chart:

import { SimaiFile, SimaiConvert } from "simai.js";

// or CommonJS version
// const { SimaiFile, SimaiConvert } = require("simai.js");

// Read it into your program
const simaiFile = new SimaiFile(chartContent);

// Specify a key to read, without the "&"
const chartKey = "inote_5";

// Get the corresponding value as a string
const rawChart = simaiFile.getValue(chartKey);

// Deserialize the chart
const chart = SimaiConvert.deserialize(rawChart);

Contribute

Issues and pull requests are welcome!