blueprint-documentation-generator-plugin-for-ue5

KO | EN

gitlite — search

#javascript #ai #typescript #go #machine-learning #rust #docker #macos #nodejs #java #kubernetes #pytorch #security #mcp

blueprint-documentation-generator-plugin-for-ue5

(★ 9)

An Unreal Engine plugin that automatically generates documentation for Blueprint assets using local AI via Ollama.

blueprint-documentation-generator-plugin-for-ue5 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Blueprint Docs: AI-Powered Documentation for Unreal Engine

## The Problem

Blueprints are powerful. They also become unmaintainable messes.

Manually documenting visual graphs is a nightmare that no one does. This creates technical debt that grinds projects to a halt. Standard documentation tools don't understand Blueprints.

## The Solution

This plugin automates documentation for your Blueprints.

It analyzes your assets and uses a local AI to write explanations for what they do. It generates clean, readable Markdown files directly in your project folder. No more excuses for undocumented assets.

## How It Works

The process is simple and runs entirely on your local machine.

1.  **Traversal:** The plugin analyzes every node, variable, function, and connection in your Blueprint graph. It builds a complete, structured representation of the asset.
2.  **AI Analysis:** The structured data is sent to a local Ollama instance. The AI generates technical explanations for each function and the overall asset logic. No data leaves your machine.
3.  **Markdown Generation:** The system combines the raw analysis and the AI explanations into a set of clear, linked Markdown files.

## Core Features

- **One-Click Documentation:** Right-click any Blueprint in the Content Browser to generate its documentation.
- **Dual Output:** Generates both structured JSON for machine use and human-readable Markdown for your team.
- **Local First:** Integrates with any local Ollama-compatible API. Your code and data stay private.
- **Handles Complexity:** Built to process large, complex Blueprints by breaking them into manageable chunks for the AI.
- **Configurable:** The Ollama endpoint and model are easily changed in your Unreal Project Settings.

## Development Philosophy

This project is built on a foundation of clean, pragmatic coding principles.

- **One Job Per Function:** Every function does one thing and does it well. Code is broken down into small, obvious units of logic. This makes it testable and easy for both humans and AI to understand.
- **Clear Separation:** The code is layered. Analysis, AI processing, and file generation are separate concerns. This keeps the system clean and allows for independent testing of each part.
- **Explicit and Testable:** We avoid side effects where possible. Functions have clear inputs and outputs. This isn't just good practice- it's essential for building reliable tools.
- **Self-Documenting Code:** The C++ source itself is heavily documented using Doxygen standards. The goal is clarity at every level, from the Blueprint it documents to the code that does the documenting.

## Current Status

This plugin is in active development.

The core pipeline- Traversal, AI Analysis, and Markdown Generation- is functional. It serves as a powerful proof-of-concept for local-first, AI-powered developer tools.

Future work will focus on improving the quality of the AI output, supporting more Blueprint node types, and refining the user interface.

## Getting Started

1.  Clone this repository into your project's `Plugins` folder.
2.  Make sure you have [Ollama](https://ollama.com/) running with a model pulled (e.g., `ollama run llama3`).
3.  Open your project. If the plugin's Ollama endpoint is not the default (`http://localhost:11434`), configure it in `Project Settings > Plugins > Blueprint Doc Settings`.
4.  Right-click a Blueprint asset and select "Generate Documentation."

blueprint-documentation-generator-plugin-for-ue5

blueprint-documentation-generator-plugin-for-ue5 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

blueprint-documentation-generator-plugin-for-ue5

blueprint-documentation-generator-plugin-for-ue5 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README