Functional Simai file parser for Typescript - basically sus analyzer for simai

Installation

npm i simai-analyzer

Usage

Deserialize the entire maidata.txt:

import { deserializeMaidata } from "simai-analyzer/simai";

const file = `
&title=(the start of) Fragrance
&artist=Tsukasa(Arte Refact)
&wholebpm=180
&inote_5=(180.0){1},{8}3,2,1,,3,4,,6,{8}5,,7,8,,{57}2,,,,,,,E`;
const { errors, chart } = deserializeMaidata(file);
doStuffWith(chart.levels[difficulty.master].noteCollections)

Deserialize a single difficulty:

import { deserializeLevel } from "simai-analyzer/simai";

const data = `(180.0){1},{8}3,2,1,,3,4,,6,{8}5,,7,8,,{57}2,,,,,,,E`;
const { errors, chart: master } = deserializeSingle(data);
doStuffWith(master.noteCollections)

See the parse type UML diagram for more details on the deserialisation output.

Serialise a single difficulty:

import { serializeSingle } from "simai-analyzer/simai";

const { errors, text } = serializeSingle(chart, offset);

Serialise an entire maidata.txt:

import { serializeMaidata } from "simai-analyzer/simai";

const { errors, text } = serializeMaidata(file);

About

Introducing a reliable and correct simai deserializer for Javascript/Typescript. The parsing algorithm is resilient so even charts with errors can still be partially loaded, and there is a great deal of testing being done on core internal functions.

The emphasis is on correctness and code readability, not performance.

[!NOTE] Currently only serialization and deserializtion of charts are supported. I might add more complex analysis tools (simai-analyzer) at a later date. Stay tuned!

What Simai Analyzer currently is not

• Fully AstroDX compatible (but should work in 99% of use-cases)
• Fully MajData/3Simai compatible

Building and Setup

1. Restore dependencies

npm install

2. Generate the parser

npm run genparser

3. Profit

At the moment, the easiest way to interact directly with the parser is through unit tests. Simply add a test under test/ and use

npm run test

to run the test suite, the existing tests should be straightforward enough to base your tests off of.

To play around with just the tokenizer, copy and paste the parser grammar into the online peggy.js parser generator. It is also possible to download the peggyjs vscode extension to test the grammar directly. Of course, unit tests are always the best way of doing tests.

Contributing

Feel free to raise issues or submit PRs in any format.