UnrealArchivist

UnrealArchivist is a powerful documentation generator for Unreal Engine 5 projects. It automatically extracts information from your C++ classes and Blueprints to generate high-quality Markdown documentation, perfectly tailored for the MkDocs Material theme.

Features

• C++ & Blueprint Support: Automatically processes both native and scripting layers.
• MkDocs Material Compatibility: Generates documentation structure and formatting optimized for a premium look.
• Automatic Configuration: Generates mkdocs.yml and index.md files to get you started immediately.
• Deep Integration: Navigates through your project's class hierarchy to ensure comprehensive coverage.

Installation

1. Clone or copy the UnrealArchivist folder into your project's Plugins/ directory.
2. Restart the Unreal Editor.
3. Enable the plugin in Edit > Plugins.
4. Rebuild your project if prompted.

Usage

1. Open the Unreal Editor.
2. (Optional) Configure settings in Edit > Project Settings > Plugins > Unreal Archivist.
   • Only Project-Specific Native Classes: If enabled, only classes defined in your project's modules will be documented.
   • Blueprint Include Paths: Add specific content folders (e.g., /Game/MyGame/) to focus documentation on specific assets.
3. Navigate to the Window menu or use the UnrealArchivist button in the Level Editor toolbar.
4. Click Generate Documentation.
5. The generated Markdown files will be located in the Plugins/UnrealArchivist/Docs folder.

Support & Documentation

• Wiki: Documentation & Guides
• Issues: Bug Reports & Feature Requests

Credits

Developed by lucastucious.