VibeUE

MCP Server for Unreal Engine

CONTRIBUTING

VibeUE is built by the community, for the community. Here's how you can help shape the future of AI-powered Unreal Engine development.

🌍

COMMUNITY-DRIVEN DEVELOPMENT

VibeUE is an open-source project that thrives on community contributions. Every bug report, feature suggestion, and pull request helps make the plugin better for all Unreal Engine developers. Whether you're fixing a typo or adding a new Python service, your contribution matters.

We actively develop on the 5-7 branch (targeting UE 5.7), and community PRs are merged regularly. Several key features and fixes already come from contributors outside the core team.

WAYS TO CONTRIBUTE

🐛

Report Bugs

Found something broken? File a GitHub issue so we can fix it.

💡

Suggest Features

Have an idea for a new tool or service? Open a feature request.

🔧

Submit Code

Fork the repo, make changes, and open a pull request.

📖

Improve Docs

Help improve documentation, skill files, or this website.

🐛

REPORTING ISSUES

How to File a Good Bug Report

  1. Go to github.com/kevinpbuckley/VibeUE/issues
  2. Click New Issue
  3. Use a clear, descriptive title (e.g., "BlueprintService: add_variable fails for TSubclassOf types")
  4. Include:
    • What you were trying to do
    • What actually happened (include error messages or log output)
    • Steps to reproduce the issue
    • Your UE version (e.g., 5.7) and VibeUE branch (e.g., 5-7)
    • AI client you're using (VS Code Copilot, Claude Desktop, In-Editor Chat, etc.)
  5. Add relevant labels if you can (bug, enhancement, documentation, etc.)

Feature Requests

Want a new Python service, MCP tool, or workflow improvement? Open an issue with the enhancement label:

  • Describe the use case — what are you trying to accomplish?
  • Explain why existing tools don't cover it
  • If possible, sketch out the API you'd like to see
🔀

SUBMITTING CODE (PULL REQUESTS)

Step-by-Step Guide

1

Fork the Repository

Go to github.com/kevinpbuckley/VibeUE and click the Fork button in the top right.

2

Clone Your Fork

git clone https://github.com/YOUR_USERNAME/VibeUE.git
cd VibeUE
git checkout 5-7
3

Create a Feature Branch

git checkout -b fix/my-bug-fix
# or
git checkout -b feat/my-new-feature

Use prefixes: fix/ for bug fixes, feat/ for features, docs/ for documentation.

4

Make Your Changes

The plugin lives under Source/VibeUE/ with this structure:

Source/VibeUE/
├── Public/PythonAPI/    # Header files for Python-exposed services
├── Private/PythonAPI/   # Implementation files
├── Public/Chat/         # In-Editor AI Chat system
├── Private/MCP/         # MCP server implementation
├── Private/Tools/       # MCP tool definitions
Content/
├── Skills/              # Domain skill documentation
├── Help/                # Tool help markdown files
└── Python/              # MCP proxy scripts
5

Build and Test

Make sure your changes compile and work in the Unreal Editor:

  • Build the plugin in your UE project (Live Coding or full rebuild)
  • Test your changes with the In-Editor Chat or an external MCP client
  • Check the Output Log for errors or warnings
6

Commit and Push

git add -A
git commit -m "fix: describe your change clearly"
git push origin fix/my-bug-fix

Use conventional commit messages: fix:, feat:, docs:, chore:

7

Open a Pull Request

Go to your fork on GitHub and click Compare & pull request.

  • Set the base branch to 5-7 (not master)
  • Write a clear description of what you changed and why
  • Reference any related issue numbers (e.g., "Fixes #42")
⚠️

IMPORTANT: TARGET THE 5-7 BRANCH

All PRs should target the 5-7 branch, which is our active development branch for UE 5.7. The master branch receives merges from 5-7 when releases are ready. PRs sent directly to master will be redirected.

📋

CODE GUIDELINES

C++ Services

  • Add new methods to the appropriate U*Service class (e.g., UBlueprintService)
  • Mark functions with UFUNCTION(BlueprintCallable) so they're exposed to Python
  • Write clear docstrings with Python usage examples — the AI reads them
  • Use UE_LOG(LogVibeUE, ...) for logging

Skills & Help Files

  • Skills live in Content/Skills/<domain>/skill.md
  • Help files live in Content/Help/<tool>/<action>.md
  • Keep workflows step-by-step and include code examples

Commit Messages

  • fix: — Bug fixes (e.g., "fix: handle null blueprint in AddVariable")
  • feat: — New features (e.g., "feat: add DiscoverNodes to BlueprintService")
  • docs: — Documentation changes
  • chore: — Build, tooling, or config changes
💬

GET IN TOUCH

📋 GitHub Issues

Report bugs and request features

github.com/kevinpbuckley/VibeUE/issues

💬 Discord

Chat with other contributors and get help

Buckley603

🙏

THANK YOU

Every contribution — big or small — helps make VibeUE better for the entire Unreal Engine community. We review all PRs and issues promptly. Let's build the future of AI-powered game development together.

← Back to Documentation