Skip to content

Contributing

Jump to bottom
Recep Samet Yıldız edited this page Sep 1, 2026 · 1 revision

Contributing

See CONTRIBUTING.md for the full contributing guide.

This page provides a quick reference for contributors.

Quick Reference

Build Environment

Requirement Version
Unreal Engine 5.8.x
OS Windows 10/11 x64
Compiler MSVC — VS 2022 17.14+ or VS 2026 18.0+

Build Steps

# 1. Place plugin in your UE project
Copy-Item -Recurse UEBPCrackerHost/Plugins/UEBPCracker $YourProject/Plugins/

# 2. Generate project files (right-click .uproject → Generate VS project files)

# 3. Build (Development Editor / Win64)

Run Headless Tests

UnrealEditor-Cmd.exe "path\to\UEBPCrackerHost.uproject" `
  -unattended -nop4 -nosplash -NullRHI `
  -ExecCmds="Automation RunTests UEBPCracker;Quit" `
  -ReportExportPath="path\to\report"
# Exit 0 = pass, 255 = failures

Code Standards (Quick Reference)

  • UE5 naming: F structs, U UObjects, A Actors
  • All public API types: UEBPCRACKEREDITOR_API
  • Error codes: UEBP.<CATEGORY>_<DETAIL> from UEBPCrackerTypes.h
  • All writes: through commit pipeline (preflight → transaction → postcondition → compile → validate → save)
  • Path inputs: FUEBPPathPolicy containment check
  • No write tool without security policy gate
  • Read UE 5.8 Gotchas before writing engine-interacting code

Commit Style

feat(toolset): add inspect_blueprint_graph tool
fix(spec): handle trailing whitespace before RapidJSON parse
docs(readme): add MCP client config example
test(module-26): add automation spec for failpoint injection

Types: feat, fix, docs, test, refactor, chore, perf, security

See Also

Clone this wiki locally