Game Asset Generator

🚀 ゲーム資産生成ツールドキュメント

このプロジェクトは、人工知能に基づくゲーム資産生成ツールで、2Dおよび3Dゲーム資産の自動生成をサポートしています。このツールは、MCP（モデルコンテキストプロトコル）と互換性があり、様々なAIクライアントにシームレスに統合することができます。

✨ 主な機能

• 2D資産生成: "gokaygokay/Flux-2D-Game-Assets-LoRA"モデルを使用（50ステップ）
• 3D資産画像生成: "gokaygokay/Flux-Game-Assets-LoRA-v2"モデルを使用（30ステップ）
• 3Dモデル変換:
  • InstantMesh: 複数ステップの処理 (/check_input_image, /preprocess, /generate_mvs, /make3d)
  • Hunyuan3D - 2: 単一ステップの処理 (/generation_all)
  • Hunyuan3D - 2mini - Turbo: 単一ステップの処理 (/generation_all)、ターボモードをサポート

📦 インストール

環境要件

• Node.jsバージョン: v16以上（確認コマンド: node --version）

設定ファイル

.envファイルを編集してツールを設定します。

# APIキーとモデルスペースの設定
HF_TOKEN=your_api_key_here
MODEL_SPACE=gokaygokay/Flux-Game-Assets-LoRA-v2

# オプション設定
PORT=3000  # SSE転送ポート、デフォルト値:3000

💻 使用例

サービスの起動

プロジェクトのルートディレクトリで以下のコマンドを実行してツールを起動します。

node src/index.js [オプションのカスタムディレクトリ]

コマンドライン引数

• --port: SSE転送ポートを指定します（デフォルト:3000）
• --directory: 資産の保存ディレクトリを設定します。

2D資産生成

generate_2d_asset "あなたの説明" [--オプション]

3D資産生成

generate_3d_asset "あなたの説明" [--オプション]

📚 ドキュメント

ファイル管理

• 保存場所: 資産は作業ディレクトリ内の./assetsフォルダに保存されます。
• 命名規則: 接頭辞、ツール名、タイムスタンプ、一意のIDを使用します（例: 2d_asset_generate_2d_asset_1698765432_abcd1234.png）。
• カスタムディレクトリ: パスを設定するには、以下のコマンドを実行します。

node src/index.js /path/to/custom/directory

MCP統合

このツールは、MCPプロトコルを通じて以下の機能を提供します。

• ツールサポート: generate_2d_asset, generate_3d_asset
• リソース管理: asset://URI形式を使用して（例: asset://2d_asset/filename.png）、資産を一覧表示または読み取ります。
• プロンプトサポート: generate_2d_sprite, generate_3d_model

トラブルシューティング

一般的な問題

• APIエラー: ネットワーク接続またはレート制限を確認し、./logs/server.logログファイルを参照します。
• 設定問題: .envファイル内のAPIキーとモデルスペースの設定が正しいことを確認します。

高度な機能

パフォーマンス最適化

• より高性能なハードウェア（GPUなど）を使用して加速します。
• 生成パラメータを最適化して効率を向上させます。

拡張性

• 生成ロジックをカスタマイズします。
• より多くのモデルや形式をサポートするように拡張します。

貢献ガイド

• コードリポジトリ: [GitHubリンク]
• 問題の報告: [問題追跡ページ]にIssueを提出してください。

📄 ライセンス

© 2024 あなたの会社名。全ての権利を保有します。

このドキュメントでは、ゲーム資産生成ツールの機能、設定、使用方法が詳細に説明されており、開発者や技術者に適しています。さらなる支援が必要な場合は、公式ドキュメントを参照するか、サポートチームにお問い合わせください。