Game Asset Generator

🚀 Game Asset Generation Tool Documentation

This project is an AI-based game asset generation tool that supports the automated generation of 2D and 3D game assets. The tool is compatible with MCP (Model Context Protocol) and can be seamlessly integrated into various AI clients.

🚀 Quick Start

Environment Requirements

• Node.js Version: v16 or higher (Verification command: node --version).

Configuration File

Edit the .env file to configure the tool:

# API key and model space settings
HF_TOKEN=your_api_key_here
MODEL_SPACE=gokaygokay/Flux-Game-Assets-LoRA-v2

# Optional configuration
PORT=3000  # SSE transmission port, default value: 3000

Starting the Service

Run the following command in the project root directory to start the tool:

node src/index.js [Optional custom directory]

Command-line Parameters

• --port: Specify the SSE transmission port (default: 3000).
• --directory: Set the asset storage directory.

✨ Features

• 2D Asset Generation: Use the "gokaygokay/Flux-2D-Game-Assets-LoRA" model (50 steps).
• 3D Asset Image Generation: Use the "gokaygokay/Flux-Game-Assets-LoRA-v2" model (30 steps).
• 3D Model Conversion:
  • InstantMesh: Multi-step processing (/check_input_image, /preprocess, /generate_mvs, /make3d).
  • Hunyuan3D-2: Single-step processing (/generation_all).
  • Hunyuan3D-2mini-Turbo: Single-step processing (/generation_all), supports turbo mode.

💻 Usage Examples

2D Asset Generation

generate_2d_asset "Your description" [--options]

3D Asset Generation

generate_3d_asset "Your description" [--options]

📚 Documentation

File Management

• Storage Location: Assets are saved in the ./assets folder within the working directory.
• Naming Rule: Use prefix, tool name, timestamp, and unique ID (e.g., 2d_asset_generate_2d_asset_1698765432_abcd1234.png).
• Custom Directory: Set the path:

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

MCP Integration

The tool provides the following functions through the MCP protocol:

• Tool Support: generate_2d_asset, generate_3d_asset.
• Resource Management: Use the asset:// URI format (e.g., asset://2d_asset/filename.png) to list or read assets.
• Prompt Support: generate_2d_sprite, generate_3d_model.

Troubleshooting

Common Issues

• API Errors: Check network connectivity or rate limits; view the ./logs/server.log file.
• Configuration Issues: Ensure that the API key and model space settings in the .env file are correct.

Advanced Features

Performance Optimization

• Use higher-performance hardware acceleration (e.g., GPU).
• Optimize generation parameters to improve efficiency.

Extensibility

• Customize generation logic.
• Expand support for more models and formats.

📄 License

© 2024 Your Company Name. All rights reserved.

🤝 Contribution Guide

• Code Repository: [GitHub Link]
• Issue Reporting: Submit issues to [Issue Tracking Page]

This document details the functions, configuration, and usage of the game asset generation tool, suitable for developers and technical personnel. For further assistance, please refer to the official documentation or contact the support team.