表示モード

akashic-cli ​

これは ​

Akashic でのゲーム開発を補助するコマンドラインツール、akashic コマンドの仕様と利用法を解説します。 akashic-cli は、Akashic でのゲーム開発を補助するコマンドラインツールです。インストールすると akashic コマンドを利用できるようになります。

インストール方法 ​

akashic コマンド は、Node.js 環境で動作します。各プラットフォームで、適当な方法で Node.js をインストールしてください。この利用ガイドでは、 LTS 版の Node.js 環境を前提に説明を進めます。執筆時点での LTS 版のバージョンは 8.11.3 です。

Windows や Mac のユーザであれば、Node.js の公式 Web サイト から適切なパッケージをダウンロードし、インストールすることができます。

sh
npm install -g @akashic/akashic-cli

使い方 ​

無事にインストールができていれば、以下のコマンドが実行できるようになっています。実行すると、akashic コマンドの簡単なヘルプが表示されます。

sh
$ akashic

akashic は以下のコマンドを持ちます。

  • akashic init
    • Akashic のゲームとして最低限動作するスクリプトやディレクトリを生成します。
  • akashic modify
    • game.json に記述されている、ゲームの各種メタ情報を更新します。
  • akashic scan
    • game.json に記述されている、ゲームのアセットや各種ライブラリ情報を更新します。
  • akashic serve
    • Akashic のゲームをホストするマルチプレイ動作確認用サーバを起動します。
  • akashic install
    • npm install を行い、追加されたファイルのリストを game.json に加えます。
  • akashic uninstall
    • npm uninstall を行い、削除されたファイルを game.json のリストから取り除きます。
  • akashic update
    • npm update を行い、 node_modules/ 以下の npm パッケージを更新し、ファイルに変更があれば game.json に加えます。
  • akashic export zip
    • ゲームを zip 形式に変換して出力します。
  • akashic export html
    • ゲームを単独で実行可能な HTML ファイル(と画像など)を含むディレクトリを生成します。
  • akashic stat
    • ゲームに関する情報を収集して出力します。

init 以外のコマンドは、init によって生成される game.json を操作・出力・実行します。したがって通常、ゲーム開発時にはまず akashic init を実行し、その後必要に応じて他コマンドを実行することになります。