unreal-engine-skills  by quodsoler

Unreal Engine C++ skills for AI coding agents

Created 4 months ago
255 stars

Top 98.8% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a curated set of 27 Unreal Engine C++ "Skills" designed to enhance AI coding agents. It addresses the common problem of AI hallucinating incorrect Unreal Engine APIs, offering game developers a way to ensure their AI assistants generate production-quality, accurate C++ code. The benefit is significantly improved reliability and efficiency when using AI for UE development.

How It Works

Skills are Markdown files containing specialized knowledge and workflows for specific Unreal Engine tasks. Each skill is meticulously audited against the Unreal Engine source code to guarantee API accuracy, including correct function signatures, valid class hierarchies, and real method names, thereby eliminating hallucinated APIs. The ue-project-context skill serves as a foundational layer, capturing project specifics like modules and conventions, which other skills leverage for context-aware advice. Skills are designed to cross-reference each other, enabling sophisticated, interconnected workflows.

Quick Start & Requirements

  • Primary Install: Use npx skills add quodsoler/unreal-engine-skills for CLI installation. Alternative methods include cloning the repository, adding it as a git submodule, or forking for customization. SkillKit can be used for multi-agent integration (npx skillkit install ...).
  • Prerequisites: A functional Unreal Engine C++ development environment is required. Specific hardware (e.g., GPU, CUDA) or Python versions are not mandated by the skills themselves.
  • Links: GitHub Repository

Highlighted Details

  • Comprehensive coverage across 27 skills, spanning Core C++, Gameplay Systems, Rendering & VFX, World & Data, AI & Logic, UI & Input, and Build & Tools.
  • Rigorous source-level API auditing has corrected over 160 inaccuracies, ensuring adherence to actual engine APIs.
  • Skills are designed for modularity and interdependency, starting with the foundational ue-project-context.

Maintenance & Community

Contributions via Pull Requests (PRs) and Issues are welcomed for improving existing skills or suggesting new ones. The repository does not currently list specific community channels (like Discord/Slack) or details on maintainers/sponsorships.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: The permissive MIT license allows for unrestricted use, modification, and distribution, including integration within commercial, closed-source projects.

Limitations & Caveats

The ue-mass-entity skill is explicitly noted as requiring Unreal Engine 5.5 or later, indicating potential version-specific dependencies for certain advanced features. The README focuses heavily on API accuracy, but does not detail other potential limitations such as platform support nuances or known bugs.

Health Check
Last Commit

4 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
61 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.