@akashic-extension/akashic-box2d
v3.1.0
Published
Box2D physics engine for Akashic
Downloads
119
Keywords
Readme
akashic-box2d
akashic-box2d は、2D物理演算ライブラリであるBox2DWebをAkashicで利用するためのモジュールです。
本モジュールでは、AkashicでBox2DWebを使う際に便利となるよう、次の機能を提供します。
- AkashicのエンティティとBox2Dとの紐づけ
- スケールや角度などの単位変換メソッド
- その他便利な機能の提供
本モジュールは AkashicとBox2DWebとの紐づけ と 一部の便利機能 のみを提供しています。 そのため、その他多くの機能はBox2DWebを直接利用することになります。
利用方法
akashic-cliをインストールした後、
akashic install @akashic-extension/akashic-box2d
でインストールできます。コンテンツからは、
var b2 = require("@akashic-extension/akashic-box2d");
で利用してください。 詳細な利用方法については、以下を参照してください。
- akashic-box2dの利用方法
- APIリファレンス
- このリポジトリ同梱のサンプルコンテンツ
Akashic Engineの詳細な利用方法については、 公式ページ を参照してください。
ビルド方法
akashic-box2d はTypeScriptで書かれたライブラリであるため、ビルドにはNode.jsが必要です。
npm run build
によりgulpを使ってビルドできます。
npm install
npm run build
テスト方法
npm test
注意点
Box2DWebでは Math.random()
が使われている箇所があります。(該当メソッド: Box2D.Common.Math.b2Math.Random()
, Box2D.Common.Math.b2Math.RandomRange()
)
該当メソッドは利用せず、かわりに g.game.random
を利用してください。
ライセンス
本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。
ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。
また、本リポジトリの patch/index.js のライセンスはファイル中記述されています。そちらをご覧ください。