nbs-reader
Version:
This package is a library that processes Note Block Studio nbs files in Note.js.
37 lines (24 loc) • 1.4 kB
Markdown
# nbs-reader
This package is a library that makes it easy to use output files (.nbs) from [Note Block Studio](https://github.com/furenjich/nbs-reader/blob/main/README/link-to-nbs.md) with
[Node.js](https://nodejs.org/en/) with ease.
# How to install.
## When using npm
In your source code folder, run ``npm install nbs-reader``.
in the source code folder.
## If you install JS files
Please install ``nbsreader.min.js`` in the repository, in the same folder as the source code.
# Usage.
Please use [``require``](https://nodejs.org/api/modules.html#modules_require_id) etc. and load it.
> **Example**.
> If you installed using npm.
> ``const NBSReader = require("nbs-reader");``
> If you installed a JS file
> ``const NBSReader = require(". /nbsreader.min.js");``
Then we run the NBSReader function (in the case of reading in the example above).
**Please enter the path to the nbs file you want to read as the argument. **.
# License
The license for this repository is [**MIT license**](https://github.com/furenjich/nbs-reader/blob/main/LICENSE).
> Anyone may handle this software free of charge and without restriction. However, the copyright notice and this permission notice must appear on all copies or significant portions of the software.
>
> The author or copyright holder assumes no responsibility for the software.
> Quoted from [Wikipedia](https://en.wikipedia.org/wiki/MIT_License)