346cafe / deresute

☕️ A library for THE iDOLM@STER Cinderella Girls Starlight Stage written in PHP.

deresute

deresuteについて

deresuteはCGSS API / AssetBundle ToolのPHP用ライブラリです。

セットアップ

必要なパッケージのインストール

$ apt -y install git g++ make cmake composer curl php-dev php-bcmath php-curl php-mbstring php-msgpack php-sqlite3

php-unity-lz4のコンパイル

• php-unity-lz4をGitからクローン

$ git clone https://github.com/towa0131/php-unity-lz4
$ cd php-unity-lz4

• コンパイル及びインストールを実行

$ ./install.sh

php-cgssのコンパイル

• php-cgssをGitからクローン

# サブモジュールも同時にクローン
$ git clone --recursive https://github.com/towa0131/php-cgss
$ cd php-cgss

• libcgssをコンパイル

$ cd libcgss
$ cmake .
$ make
$ cp bin/x64/libcgss.* /usr/lib/

• php-cgssをコンパイル

$ cd ..
$ phpize
$ ./configure

# インストール
$ make install

エクステンションがインストールされるのでphp.iniファイルにextension=unitylz4, extension=cgssを追加し、有効化してください。

deresute本体のセットアップ

下記のいずれかの方法でインストールが可能です。

Gitからクローン

• deresuteをGitからクローン

$ git clone https://github.com/346Cafe/deresute
$ cd deresute

• 各ライブラリのインストール

$ composer install

Packagistからダウンロード

• deresuteのダウンロード / 各ライブラリのインストール

$ composer require towa0131/deresute

テストの実行

• Gitからダウンロードした場合

$ php test-app.php

• Packagistからダウンロードした場合

$ php vendor/towa0131/deresute/test-app.php

機能

音声ファイル/アセットバンドルのダウンロード

deresuteの機能の一つとして、音声ファイル、アセットバンドルのダウンロード機能があります。

$ cd tools/AssetDownloader/
$ php app.php

音声ファイルはすべてのファイルのダウンロード完了後、自動でWAVEフォーマットに変換されます。

追加予定の機能

• アカウントの作成機能
  • 正規クライアントへのアカウントの引継ぎ
• ダウンロードするデータをユーザが指定可能にする

FAQ

unitylz4のコンパイルでエラー

事前パッケージのインストールはされていますか？ もしされていないならコンパイルの前にインストールを行なってください。

本体のAPIの使用時にエラー

必要なエクステンションがインストールされていない可能性があります。一度、php test-app.phpでテストスクリプトを実行し、エラーが発生しないか確認してください。

test-app.phpの実行時にエラー

No module loaded : msgpackなどの文が表示されていませんか？ もしされているのならば、必要なエクステンションがインストールされていません。インストールを行うことでエラーが発生しなくなります。

わからないことがあれば

お気軽にIssues、Twitterにてご質問お願いします。

使用しているライブラリ

• towa0131/php-unity-lz4 - unity3d.lz4フォーマットを扱うPHPエクステンション
• towa0131/php-cgss - ACBファイルの展開、HCAファイルのデコードを行うPHPエクステンション
• phpseclib/mcrypt_compat - データの暗号化 / 復号化を行うライブラリ
• gabrielelana/byte-units - バイト数値をパースするためのライブラリ
• j4mie/idiorm - ORMを扱うライブラリ

deresute's Issues

書き直したい

あまりにもコードが汚い、可読性が悪いので書き直したい