haydee-outfit-generator 1.0.3

Automated pipeline to generate custom outfit textures for Haydee using Gemini API.

Haydee Outfit Generator (Powered by Gemini)

Automated Python pipeline to generate custom outfit textures for the game Haydee using the Google Gemini API.

[!TIP] Not a fan of the command line? Check out the Haydee AI Outfit Generator GUI! It's a modern, ready-to-use graphical interface that lets you easily generate custom outfits without messing with terminals or environment variables. Download the latest release to get started instantly!

✨ Generation Examples

Lunar Scout Outfit	Neon Surge Outfit	Steam Gear Outfit	Tomb Awakened Outfit
Waaagh Bot Outfit	Wastelander Outfit	Xenomorph Outfit	Berry Sweet Outfit
Tech-Priestess Outfit	Astro White Outfit	Battle Sister Outfit	Gothic Automaton Outfit
Candy Pop Outfit	Hellwalker Outfit	Retrowave Outfit	Iron Utopia Outfit

📋 Prerequisites

• Python 3.12+

🔑 Getting a Gemini API Key

1. Go to Google AI Studio.
2. Sign in with your Google account.
3. Click the "Create API key" button.
4. If prompted, read and accept the terms of service.
5. Click on "Create API key in new project" (or use an existing project).
6. Copy the generated key. You will need it for the .env file in the setup steps below.
7. Note: Generating and using the Gemini API key is completely free within generous rate limits.

💻 Setup (Local)

Install via pip (Recommended)

The easiest way to install the generator is directly from PyPI:

pip install haydee-outfit-generator

Install from Source

1. Clone the repository.

2. Install dependencies:

   pip install .
   

3. Copy .env.example to .env (or create one) and configure your variables:

• GEMINI_API_KEY: Your Google Gemini API Key.
• HAYDEE_PATH: Absolute path to your Haydee installation directory.
• IMAGE_RESOLUTION: (Optional) Output resolution. Default is 4K. Can be set to 2K (2048x2048) if needed.

🐳 Setup (Docker)

If you prefer to run the project without installing Python locally, you can use Docker.

1. Install Docker Desktop.
2. Create your .env file and set GEMINI_API_KEY and HAYDEE_PATH.
   • Note: HAYDEE_PATH in .env must be the absolute path on your host Windows machine (e.g., C:\Program Files (x86)\Steam\steamapps\common\Haydee).

🚀 Usage

Running Locally

Run the script by providing the mod name and the desired style description:

haydee-gen --name "NeonSurge" --style "cyberpunk neon lights with dark carbon fiber armor"

Running with Docker

You can use Docker Compose to automatically mount your Haydee directory and run the command:

docker-compose run --rm generator --name "NeonSurge" --style "cyberpunk neon lights with dark carbon fiber armor"

The script will automatically read the base texture, contact the Gemini API, convert the formats, and generate the mod inside your Haydee/Outfits folder.

📤 Publishing to Steam Workshop

When you are ready to share your generated outfit, you can upload it directly to the Steam Workshop using the game's built-in tools.

1. Prepare a Thumbnail

• Create a preview image for your mod (preview.png or preview.jpg).
• The image should be square (e.g., 512x512 or 256x256).
• Place this image in your mod folder.

2. Launch Edith Editor

The upload tools are located in the game's editor, not the game itself:

• Go to your Haydee root installation folder.
• Run Edith.exe.
• In the top menu bar, select Tool -> Workshop Uploader.

3. Fill in the Uploader Data

In the uploader window, fill out the following fields:

• Mod Content: At the very top of the upload form, there is a text field with a Browse button beneath it. You will use this to build the list of files to upload:
  1. Click Browse and add your mod's main folder (for example, select Outfits/NeonSurge).
  2. Click Browse again and add your .outfit definition file (for example, select Outfits/NeonSurge.outfit). (This ensures you include the full set of files required for the mod to work).
• Title: The name of your outfit (this will be displayed on Steam).
• Description: A short description of the mod (what it is, special features, etc.).
• Visibility: It is recommended to set this to Private first to verify how everything looks on the Steam page, and change it to Public later.
• Preview Image: Select the thumbnail image you prepared in step 1.

Once filled out, click Upload. If everything goes well, the status at the bottom will show "Success".

🧪 Testing

This project uses pytest for automated testing.

1. Install the development dependencies:

   pip install -r requirements-dev.txt
   

2. Run the test suite with coverage:

   pytest
   

   Note: Valid API Keys or a real Haydee installation are not required to run the tests, as external dependencies and the filesystem are safely mocked.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.