@akashic/pdi-browser
v2.10.2
Published
An akashic-pdi implementation for Web browsers
Downloads
4,423
Keywords
Readme
pdi-browser
pdi-browser は、 akashic-pdiのWebブラウザ向け実装です。
このモジュールは、 Akashic Engineの実行系(akashic-sandboxなど)に組み込まれています。 ゲーム開発者(Akashic Engineの利用者)がこのモジュールを直接利用する必要はありません。
インストール
Node.jsが必要です。次のコマンドでインストールできます。
npm install @akashic/pdi-browser
ビルド方法
TypeScriptで書かれています。インストール後にビルドしてください。
npm install
npm run build
利用方法
require()
してください。
require("@akashic/pdi-browser");
require("@akashic/pdi-browser/lib/canvas"); // WebGLを利用するRenderer実装が不要な場合
テスト方法
npm test
jest によるユニットテスト
npm run jest:unit
jest による E2E テスト
実行前に npm run build
で ./build/pdi-browser.js
が生成されていることを確認してください。
npm run jest:e2e
レンダラの E2E テスト
Canvas, WebGL による E2E テストの描画結果は ./e2e/tests/renderer/results/
に出力されます。
ライセンス
本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。
ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。