SS6Player for pixi.js

OPTPiX SpriteStudio 7.0 と OPTPiX SpriteStudio 6 で制作したアニメーションを pixi.js v8 で再生するライブラリです。

ライブラリ

リリース最新版のライブラリソースは こちら(minified) になります。

デモ

リリース最新版のデモは こちら になります。

UI デモは こちら になります。

ライセンス

ss6player-pixi のライセンスは LISENCE となります。

ss6player-pixi は依存ライブラリの FlatBuffers と ssfblib と ss6player-lib をバンドルしています。 ForWeb のコンポーネントが依存しているサードパーティライブラリのライセンスは ThirdPartyLicenses.md を参照してください。

アニメーションデータの作成方法

SpriteStudio 6 のプロジェクトファイル sspj からアニメーションデータファイル ssfb ファイルをコンバートします。 コンバートには Ss6Converter を利用します。

Ss6Converter は SpriteStudio6-SDK に同封するツールです。利用方法に関してはこちらを参照してください

使い方

API リファレンス

ss6player-pixi の API リファレンスはこちらです。

サンプル

Player ディレクトリの index.html と sample.js を参考にしてください。

デモ ページを閲覧するか、あるいはローカル環境で動作確認ができます。

For Developer

ライブラリを開発する方、あるいは開発版のライブラリの動作を確認したい方向けです。

ビルド

ソースの取得方法やビルドに必要な npm のインストール手順は wiki を参照してください。

全ビルド

SS6PlayerForWeb/ ディレクトリ上で下記コマンドを実行すると、 packages/ 以下の全ライブラリをビルドします。

cd SS6PlayerForWeb
npm i
npm run build
Copy

ビルドが成功すると ss6player-pixi.umd.js と ss6player-pixi.es6.js が SS6PlayerForWeb/packages/ss6player-pixi/dist ディレクトリ以下に生成されます。

単独ビルド

全ビルド実行後は SS6PlayerForWeb/packages/ss6player-pixi ディレクトリ上で ss6player-pixi の単独ビルドが可能になります。

cd SS6PlayerForWeb/packages/ss6player-pixi
npm run build
Copy

ローカル環境での動作確認

全ビルド後、SS6PlayerForWeb/packages/ss6player-pixi/ ディレクトリ上で下記コマンドを実行してください。

ローカル環境で http サーバが起動し、ブラウザ上で Player ディレクトリのサンプルを表示します。

cd SS6PlayerForWeb/packages/ss6player-pixi
npm run view
Copy

単独ビルドの監視

SS6PlayerForWeb/packages/ss6player-pixi ディレクトリ上で npm run start を実行すると、 src/ ディレクトリのソースファイルが変更されると自動的に単独ビルドが走るようになります。

ローカル環境での動作確認 と併用するとスムーズに動作確認が行なえます。

cd SS6PlayerForWeb/packages/ss6player-pixi
npm run start
Copy