Game Asset Generator

🚀 遊戲資產生成工具文檔

本項目是一款基於人工智能的遊戲資產生成工具，支持2D和3D遊戲資產的自動化生成。它與MCP（模型上下文協議）兼容，可無縫集成到各類AI客戶端中，為遊戲開發提供高效的資產生成解決方案。

🚀 快速開始

環境要求

• 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 [可選自定義目錄]

✨ 主要特性

• 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密鑰和模型空間等參數：

# API密鑰和模型空間設置
HF_TOKEN=your_api_key_here
MODEL_SPACE=gokaygokay/Flux-Game-Assets-LoRA-v2

# 可選配置
PORT=3000  # SSE傳輸端口，默認值:3000

💻 使用示例

2D資產生成

generate_2d_asset "你的描述" [--options]

3D資產生成

generate_3d_asset "你的描述" [--options]

命令行參數

• --port：指定SSE傳輸端口（默認：3000）
• --directory：設置資產存儲目錄

📚 詳細文檔

文件管理

• 存儲位置：資產保存在工作目錄中的./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）
• 優化生成參數以提高效率

擴展性

• 自定義生成邏輯
• 擴展支持更多模型和格式

📄 許可證

© 2024 您的公司名稱。保留所有權利。

該文檔詳細介紹了遊戲資產生成工具的功能、配置和使用方法，適用於開發者和技術人員。如需進一步幫助，請參考官方文檔或聯繫支持團隊。

貢獻指南

• 代碼倉庫：[GitHub鏈接]
• 問題反饋：提交Issue至[問題跟蹤頁面]