nbs-reader
Version:
This package is a library that processes Note Block Studio nbs files in Note.js.
37 lines (24 loc) • 1.68 kB
Markdown
# nbs-reader
このパッケージは、[Note Block Studio](https://github.com/furenjich/nbs-reader/blob/main/README/link-to-nbs.md)の出力ファイル(.nbs)を、
[Node.js](https://nodejs.org/ja/)で簡単に使用するためのライブラリやねん。
# インストール方法
## npmを使用する場合
ソースコードのフォルダ内でぇ``npm install nbs-reader``
を実行してみぃな。
## JSファイルを設置する場合
レポジトリ内の``nbsreader.min.js``を、ソースコードって同じフォルダに設置してみぃな。
# 使用方法
[``require``](https://nodejs.org/api/modules.html#modules_require_id)やらなんやらを使用し、読み込んでぇほしいんやけど。
> **例**
> npmを使用してインストールした場合
> ``const NBSReader = require("nbs-reader");``
> JSファイルを設置した場合
> ``const NBSReader = require("./nbsreader.min.js");``
ほんで、NBSReader関数(上の例でぇ読み込んや場合)を実行するわ。
**引数には、読み込みたいnbsファイルのパスを入れてみてな。**
# ライセンス
このレポジトリのライセンスは[**MITライセンス**](https://github.com/furenjich/nbs-reader/blob/main/LICENSE)やねん。
> このソフトウェアを誰でも無償で無制限に扱って良い。ただし、著作権表示および本許諾表示をソフトウェアのすべての複製または重要な部分に記載しなければならない。
>
> 作者または著作権者は、ソフトウェアに関してなんら責任を負わない。
> [Wikipedia](https://ja.wikipedia.org/wiki/MIT_License)より引用