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至[问题跟踪页面]