typescript-game-sampleはTypeScriptでAkashicのゲームを作る際のサンプルプロジェクトです。
typescript-game-sample
を利用するにはNode.jsが必要です。
初回のみ、以下のコマンドを実行して、ビルドに必要なパッケージをインストールしてください。
この作業は typescript-game-sample
を新しく生成するごとに必要です。
npm install
typescript-game-sample
はTypeScriptで書かれているため、以下のコマンドでJavaScriptファイルに変換する必要があります。
npm run build
src
ディレクトリ以下のTypeScriptファイルがコンパイルされ、script
ディレクトリ以下にJavaScriptファイルが生成されます。
npm run build
は自動的に akashic scan asset script
を実行するので、game.json
の更新が行われます。
以下のどちらかを実行後、ブラウザで http://localhost:3000/game/
にアクセスすることでゲームを実行できます。
-
npm start
-
npm install -g @akashic/akashic-sandbox
後、akashic-sandbox .
src/main.ts
を編集することでゲームの作成が可能です。- スプライトの表示、音を鳴らす、タッチイベント定義等が、最初からこのテンプレートで行われています。
src/main.ts
を編集することでゲームの作成が可能です。- 基本的な使い方は typescript テンプレートと同じですが、このテンプレートでは最低限のものしか記述されていないため以下のことは行われていません。
- スプライトの表示
- 音を鳴らす
- タッチイベント定義
- ゲーム部分を作成する場合は、
src/main.ts
を編集してください。- 基本的に
src/_bootstrap.ts
を編集する必要はありません。
- 基本的に
- 基本的な使い方は typescript テンプレートと同じですが、このテンプレートでは
src/main.ts
のmain
関数の引数param
に以下の値が新たに付与されています。param.sessionParameter
: セッションパラメーターparam.isAtsumaru
:コンテンツが動作している環境がゲームアツマール上かどうかを表すbool値
- ランキングモードに対応したニコニコ新市場コンテンツの作り方の詳細については、こちらを参照してください。
各種アセットを追加したい場合は、それぞれのアセットファイルを以下のディレクトリに格納します。
- 画像アセット:
image
- スクリプトアセット:
script
- テキストアセット:
text
- オーディオアセット:
audio
これらのアセットを追加・変更したあとに npm run update
をすると、アセットの変更内容をもとに game.json
を書き換えることができます。
typescript-game-sample
でnpmモジュールを利用する場合、このディレクトリで akashic install <package_name>
することで npm モジュールを追加することができます。
また akashic uninstall <package_name>
すると npm モジュールを削除することができます。
typescript-game-sample
をエクスポートするときは以下のコマンドを利用します。
npm run export-html
のコマンドを利用することで game
ディレクトリにエクスポートすることができます。
game/index.html
をブラウザで開くと単体動作させることができます。
npm run export-zip
のコマンドを利用することで game.zip
という名前のzipファイルを出力できます。
がそれぞれ実行されます。
npm test
テストコードのサンプルとして spec/testSpec.js
を用意していますので参考にしてテストコードを記述して下さい。