UNPKG

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
# 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)より引用