CONTRIBUTING TO VibeUE
VibeUE is built by the community, for the community. Bug reports, new toolsets, agent skills, docs — every contribution makes it better.
✨Ways to Contribute
Report Issues
Hit a bug or a rough edge? Open a GitHub issue with repro steps, your UE version, and what you expected.
Add or Extend Toolsets
Add methods to an existing service or build a new one. It registers onto UE5.8's ToolsetRegistry automatically.
Write Agent Skills
Capture a workflow, gotcha, or property format as a skill pack served by the AgentSkillToolset.
Improve Docs
Fix a typo, clarify a step, or document a service. Docs PRs are some of the most valuable.
🛠️Set Up a Dev Build
Fork & clone the 5-8 branch
Fork kevinpbuckley/VibeUE on GitHub, then clone your fork's 5-8 branch into a UE 5.8 project's Plugins/ folder:
git clone -b 5-8 https://github.com/<your-user>/VibeUE.git
Build & enable
Run BuildAndLaunchGame.ps1 (Windows) or BuildAndLaunchGame.sh --engine /path/to/UE5 (Linux) from the plugin root, enable VibeUE in Edit → Plugins, and restart the editor. Make sure UE 5.8's native MCP server is configured (see the setup docs). Check the repo README for the latest build details.
Branch, change, verify
Create a feature branch off 5-8, make your change, and test it live in the editor — confirm your tool or skill shows up on the MCP endpoint and behaves as expected before opening a PR.
🧭Where Things Live
VibeUE extends three native UE 5.8 systems — knowing which one your change targets tells you where it goes:
- ToolsetRegistry— Service classes whose AICallable methods become tools. Add a method to an existing service, or add a new service, and it registers automatically.
- ModelContextProtocol— Utility tools (
execute_python_code, thediscover_python_*family,read_logs). - AgentSkillToolset— Lazy-loaded skill packs (markdown knowledge). Add or refine a skill so agents pick up the right workflow.
Browse the existing toolsets to see the patterns before adding your own.
🧪Create Test Prompts
VibeUE is driven by AI agents, so the best way to test a change is with test prompts — the plain-language requests a real user would type to exercise your tool or skill. Every new toolset method, skill, or bug fix should ship with prompts a maintainer can run against a live editor to confirm it works.
What makes a good test prompt
- ▹Phrase it like a user — natural language, not a literal tool call. The point is to check the agent picks the right tool and arguments on its own.
- ▹State the expected result — what should change in the editor, and what the agent should report back, so a reviewer can tell pass from fail.
- ▹Be deterministic — use specific asset names and paths (e.g.
/Game/Tests/BP_Probe) so the prompt is repeatable. - ▹Cover the happy path and an edge case — at least one normal use plus one failure/guard case (missing asset, bad input, idempotent re-run).
- ▹Include them in your PR — paste the prompts and expected outcomes in the PR description (or add them to the repo's test-prompts location if one exists for the area you're touching).
Example for a new add_member_variable capability:
Prompt: "In BP_Probe at /Game/Tests, add a float variable named Health defaulting to 100, then compile it."
Expect: Health (Float, default 100) exists on the Blueprint; compile succeeds; agent confirms the variable and value.
# Edge case
Prompt: "Add a variable named Health to BP_Probe again."
Expect: agent reports the variable already exists and does not create a duplicate or error out.
🚀Submit a Pull Request
- ▹Open your PR against the
5-8branch of kevinpbuckley/VibeUE. - ▹Keep PRs focused — one feature or fix per PR is easiest to review and merge.
- ▹Include test prompts with expected outcomes (see above) so a reviewer can reproduce your verification.
- ▹Describe what changed and why, and note how you verified it in the editor.
- ▹Match the surrounding code style and naming conventions of the service or skill you're touching.
- ▹Not sure about an approach? Open an issue or ask on Discord first — it saves rework.
Ready to jump in?
Grab the 5-8 branch, pick an issue, and say hi on Discord. We'd love your help.