Skip to content

akashic install

sh
akashic install [<module>]

npm install のラッパーコマンドです。

<module> を与えた場合、 npm install --save <module> を行い、また導入されたファイルの一覧を game.json に加えます。すなわち次のコマンドと概ね等価な振る舞いをします。

sh
npm install --save <module>
akashic scan globalScripts

@akashic-extension/ で提供される Akashic 向けの拡張機能の他、任意の npm パッケージをゲームに導入することができます。

注意: Akashic は Node.js のコアモジュール(http, path など)をサポートしていません。コアモジュールに依存しているパッケージを導入した場合、npm install は行われ、game.json も更新されますが、ゲームとして実行しようとするとエラーになります。

またブラウザ固有の機能や、ECMAScript の一部機能 (Math.random() のような内部状態を持つ機能など) は、 Akashic のゲームとしてはサポートされていません。それらの機能を用いる npm パッケージを導入しないでください。 (akashic コマンド はこれにエラーを出すことはできません。)

このコマンドは npm install を行うため、game.json と同じディレクトリに package.json という名前のファイルが存在する必要があります。事前に npm init を行うなどの方法で作成してください。 (akashic init が提供するビルトインのテンプレートには含まれています。)

<module> を省略した場合、単に npm install を行います。 (package.json に依存生が記録されたパッケージが導入されます。) game.json は更新されません。package-lock.json がない場合、利用しないでください。 (意図しないバージョンのパッケージが導入される可能性があります。)

Node.js 開発者向けの追加情報

akashic は、install, uninstall コマンドを除き、package.json に関知しません。

ゲーム開発者は、npm install --save-dev jasmine して spec ディレクトリにテストを配置するなど、任意の開発フローを(Akashic のディレクトリ構成と衝突するなどの問題がない限り)とることができます。