akashic-cli

Akashic Engine を使ったゲーム作成を補助するコマンドラインユーティリティです。

インストール

akashic-cli は Node.js v4.2 以降で動作します。 以下のコマンドでインストールできます。

npm install -g @akashic/akashic-cli

利用方法

インストール後、 akashic コマンドが利用できるようになります。

例: カレントディレクトリに空のAkashicゲームを生成

akashic init

例: カレントディレクトリ以下のファイルを検索してアセットとして追加

akashic scan asset

例: カレントディレクトリのAkashicゲームをホストするマルチプレイ動作確認用サーバを起動

akashic serve

例: カレントディレクトリのAkashicゲームを、HTMLファイル(と画像・音声をまとめたディレクトリ)に変換し、 ../exported-my-game/ に出力する

akashic export html -o ../exported-my-game

各コマンドの詳細については、 利用ガイド を参照してください。 Akashic Engineの詳細な利用方法については、 公式ページ を参照してください。

ビルド方法

akashic-cli はTypeScriptで書かれたJSモジュールです。ビルドにはNode.jsが必要です。 リポジトリ直下で次を実行してください。

npm install
npm run build

これにより packages ディレクトリ以下の各モジュールがリンクされ、互いに利用できるようになります。

開発者向け

バージョンの更新

akashic-cli への PullRequest 作成時に changeset を利用して変更内容を記録します。

npm run changeset

対話型プロンプトにより変更内容を入力後 ./.changeset ディレクトリに出力されるファイルを PullRequest のコミットに含めてください。

対象の PullRequest をマージするとバージョン更新の PullRequest が自動的に作成されます。 内容を確認後、その PullRequest をマージすることで publish が完了します。

publish 時の npm-shrinkwrap.json の追加

npm publish の実行タイミングで ./scripts/generateShrinkwrapJson.js が実行されます。 publish 時、各パッケージの依存関係のバージョンを固定するために npm-shrinkwrap.json を追加するスクリプトです。

akashic-cli がモノレポであることや、akashic-cli の publish が行われた場合に、akashic-cli-xxxxx が npm i --before <date> でエラーとなる事を考慮し、スクリプトは下記の手順で npm-shrinkwrap.json を作成します。

1. ルートの package.json, package-lock.json をリネーム
2. 依存モジュールが publish 済みかポーリングして確認
3. ロックファイルを作成。ロックファイルが作成済みの場合はポーリングで待つ
4. 各パッケージの package.json の dependencies/devDependencies から @akashic/xxxxx を削除し npm i --before <実行日の七日前> を実行
5. 4 で削除した @akashic/xxxxx を npm インストール
6. npm shrinkwarp を実行
7. 1 でリネームした package.json, package-lock.json を戻し、ロックファイルを削除

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。