Skip to content

docs: engine plugin system for game-engine agnostic orchestration#544

Closed
frostebite wants to merge 1 commit intorelease/lts-2.0.0from
docs/engine-plugins
Closed

docs: engine plugin system for game-engine agnostic orchestration#544
frostebite wants to merge 1 commit intorelease/lts-2.0.0from
docs/engine-plugins

Conversation

@frostebite
Copy link
Member

Summary

Documents the new engine plugin system from game-ci/orchestrator#4 that makes the orchestrator game-engine agnostic.

  • New page: Advanced Topics > Engine Plugins — full guide covering the EnginePlugin interface, plugin sources (npm module, CLI executable, Docker image), and how to author plugins
  • Updated introduction to mention engine agnosticism as a key benefit
  • Updated caching page to reference engine-aware cache folders instead of hardcoded "Library"
  • Added engine and enginePlugin to API reference parameters
  • Added --engine and --engine-plugin to CLI build command docs

Changes

File Change
01-introduction.mdx Mention engine agnosticism in intro paragraph and benefits table
05-api-reference.mdx New Engine parameters section
07-advanced-topics/01-caching.mdx Reference engine plugin for cache folders
07-advanced-topics/18-engine-plugins.mdx New full page
08-cli/02-build-command.mdx New Engine Options section with example

🤖 Generated with Claude Code

…ation

Add documentation for the new EnginePlugin interface that allows the
orchestrator to support non-Unity engines (Godot, Unreal, custom).

- New page: Advanced Topics > Engine Plugins — full guide covering the
  interface, plugin sources (npm, CLI, Docker), and authoring plugins
- Updated introduction to mention engine agnosticism
- Updated caching page to reference engine-aware cache folders
- Added engine/enginePlugin to API reference parameters
- Added --engine and --engine-plugin to CLI build command docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 14, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8cc02017-01d0-4331-a776-cc3ab65c4fde

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/engine-plugins
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

Cat Gif

@github-actions
Copy link

Visit the preview URL for this PR (updated for commit 0feb581):

https://game-ci-5559f--pr544-docs-engine-plugins-8hnqwoz2.web.app

(expires Sat, 21 Mar 2026 04:12:42 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 1f0574f15f83e11bfc148eae8646486a6d0e078b

@frostebite
Copy link
Member Author

Merged into release/lts-2.0.0. Related orchestrator PR: game-ci/orchestrator#4

@frostebite frostebite closed this Mar 14, 2026
@frostebite frostebite mentioned this pull request Mar 14, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant