拡張ライブラリを導入する

拡張ライブラリを導入するには akashic コマンドの akashic install を利用します。

凡例

akashic install @akashic-extension/akashic-timeline

インストールしたライブラリの利用方法は、各ライブラリの README などを参照してください。

詳細

akashic install コマンドは game.json の置かれているディレクトリでコマンドを実行します。

このコマンドは、内部的に npm install --save -save-exact を実行することで、拡張ライブラリを node_modules ディレクトリにダウンロード・インストールします。さらに、インストールされた拡張ライブラリの情報(ファイルパスなど)を game.json に書き込みます。これは、Akashic コンテンツでは、予めすべてのリソースへのパスが game.json に書き込まれている必要があるためです。これによりコンテンツ内から require() を使って拡張ライブラリを読み込めるようになります。

akashic-timeline の拡張ライブラリをコンテンツに追加すると、game.json には以下のような記述が追加されます。game.json に追加される記述についてはゲーム開発者が意識する必要はありません。

{
    ...
    "globalScripts": [
        "node_modules/@akashic-extension/akashic-timeline/lib/ActionType.js",
        "node_modules/@akashic-extension/akashic-timeline/lib/Easing.js",
        "node_modules/@akashic-extension/akashic-timeline/lib/Timeline.js",
        "node_modules/@akashic-extension/akashic-timeline/lib/Tween.js",
        "node_modules/@akashic-extension/akashic-timeline/lib/index.js"
    ],
    "moduleMainScripts": {
        "@akashic-extension/akashic-timeline": "node_modules/@akashic-extension/akashic-timeline/lib/index.js"
    }
}

公式に提供されている Akashic 向け拡張ライブラリには次のようなものがあります。

akashic-animation: Akashic Engine 用のアニメーションライブラリです。
akashic-box2d: 2D 物理演算ライブラリである Box2DWeb を Akashic で利用するためのモジュールです。
akashic-hover-plugin: Akashic でマウスホバー可能なエンティティを利用することができるプラグインです。
akashic-label:Akashic Engine 用のテキスト描画ライブラリです。
akashic-tile: Akashic Engine 用のタイルマップ描画ライブラリです。
akashic-timeline:Akashic Engine 用のトゥイーンアニメーションライブラリです。
collision-js: 算術ライブラリを含むコリジョンライブラリです。
raycaster-js: raycasting 法によってタイルマップを 3D 描画するソフトウェアレンダラーです。

公式で公開されている Akashic Engine 向け拡張ライブラリ以外のライブラリを利用する場合は、それら各ライブラリの利用条件・ライセンスにも従う必要があります。

Akashic Engine 逆引きリファレンス

拡張ライブラリを導入する

凡例

詳細

関連情報