refactor(core): rename RunCore to Run for clarity by Miou-zora · Pull Request #581 · EngineSquared/EngineSquared · GitHub

Pull Request

Description

Renamed "RunCore" method to "Run".

Related Issues (Put "None" if there are no related issues)

close #489

Type of Change

Please delete options that are not relevant.

Breaking change (fix or feature that would cause existing functionality to not work as expected)

Changes Made

List the main changes in this PR:

Renamed "RunCore" method to "Run"

Testing

Describe the tests you ran to verify your changes. Please delete options that are not relevant.

Unit tests pass (xmake test)

Test Environment

OS: macOS
Compiler: Clang

Screenshots/Videos (Put "None" if there are no related issues)

None

Documentation

Please delete options that are not relevant.

No documentation changes are required

Checklist (Don't delete any options)

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published

Breaking Changes (Put "None" if there are no related issues)

None

Additional Notes (Put "None" if there are no related issues)

None

Summary by CodeRabbit

Breaking Changes
- The engine startup API was renamed; update application initialization to use the new startup call.
Documentation
- Examples and docs updated to show the new startup approach.
Tests
- Test harnesses updated to invoke the new startup entrypoint.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info ⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2ea7bf31-a87c-4a08-87dc-66a4dc6f3b6f

📥 Commits

Reviewing files that changed from the base of the PR and between f5c9c75 and e4a4b12.

📒 Files selected for processing (1)

README.md

✅ Files skipped from review due to trivial changes (1)

README.md

📝 Walkthrough

Walkthrough

Renamed the engine run entrypoint from Engine::Core::RunCore() to Engine::Core::Run() and updated all call sites, documentation, examples, and a test to use the new method name. No other API signatures or runtime behavior were altered.

Changes

Cohort / File(s)	Summary
Core API src/engine/src/core/Core.hpp, src/engine/src/core/Core.cpp	Renamed public method RunCore() → Run(void); implementation retains existing run-loop behavior and _running semantics.
Examples (main entrypoints) examples/basic_core_usage/src/main.cpp, examples/character_controller_usage/src/main.cpp, examples/graphic_light_usage/src/main.cpp, examples/graphic_material_usage/src/main.cpp, examples/graphic_usage/src/main.cpp, examples/graphic_usage_with_physics/src/main.cpp, examples/input_usage/src/main.cpp, examples/physics_usage/src/main.cpp, examples/softbody_usage/src/main.cpp, examples/sound_usage/src/main.cpp, examples/vehicle_usage/src/main.cpp	Replaced calls to core.RunCore() with core.Run() across example main files.
RMLui examples examples/rmlui_usage/src/Animation.cpp, examples/rmlui_usage/src/Demo.cpp, examples/rmlui_usage/src/Transform.cpp, examples/rmlui_usage/src/main.cpp	Updated core run calls from core.RunCore() → core.Run().
Documentation README.md, src/plugin/graphic/README.md	Updated inline comment and example code to reference core.Run() instead of core.RunCore().
Tests src/plugin/physics/tests/VehicleForwardMovementTest.cpp	Updated test harness call from c.RunCore() → c.Run().

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

feat(Graphic): adding the README file #477 — Modifies the Graphic README; overlaps with this PR's Graphic README update.
example: vehicle usage example #426 — Related prior/parallel change addressing Core run API renaming and example updates.

Suggested labels

enhancement

Suggested reviewers

ripel2

Poem

🐰 I hopped through code at break of dawn,

Swapped "RunCore" so the wording's gone,
Now with a twitch and whisker-fun,
I say aloud: just call core.Run()! 🥕

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 22.22% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately summarizes the primary change: renaming RunCore to Run in the Core class.
Linked Issues check	✅ Passed	The pull request fully implements the objective from issue #489: renames Engine::Core::RunCore() to Run() and updates all usages across the codebase.
Out of Scope Changes check	✅ Passed	All changes are directly related to renaming RunCore to Run; no unrelated modifications found.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches 🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch 489-feature-rename-coreruncore-to-a-cleaner-name-run-or-start

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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 168: The comment on core.RunSystems() is unclear and ungrammatical;
update it to a concise, correct explanation referencing the RunSystems(), Run(),
and Stop() APIs — e.g., state that core.RunSystems() executes systems once,
while Run() starts the scheduler and runs systems repeatedly until Stop() is
called — and replace the existing sentence ("RunSystems() run them only one time
and Run() run all scheduler indefinitely until Stop() is called") with the
tightened wording.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info ⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d886924c-b8a8-482c-b9b6-57c6f35aec5c

📥 Commits

Reviewing files that changed from the base of the PR and between 404f7b7 and f5c9c75.

📒 Files selected for processing (20)

README.md
examples/basic_core_usage/src/main.cpp
examples/character_controller_usage/src/main.cpp
examples/graphic_light_usage/src/main.cpp
examples/graphic_material_usage/src/main.cpp
examples/graphic_usage/src/main.cpp
examples/graphic_usage_with_physics/src/main.cpp
examples/input_usage/src/main.cpp
examples/physics_usage/src/main.cpp
examples/rmlui_usage/src/Animation.cpp
examples/rmlui_usage/src/Demo.cpp
examples/rmlui_usage/src/Transform.cpp
examples/rmlui_usage/src/main.cpp
examples/softbody_usage/src/main.cpp
examples/sound_usage/src/main.cpp
examples/vehicle_usage/src/main.cpp
src/engine/src/core/Core.cpp
src/engine/src/core/Core.hpp
src/plugin/graphic/README.md
src/plugin/physics/tests/VehicleForwardMovementTest.cpp

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

refactor(core): rename RunCore to Run for clarity

f5c9c75

Miou-zora self-assigned this Apr 11, 2026

Miou-zora linked an issue Apr 11, 2026 that may be closed by this pull request

[FEATURE] Rename Core::RunCore() to a cleaner name (Run or Start) #489

Closed

coderabbitai Bot reviewed Apr 11, 2026

View reviewed changes

Comment thread README.md Outdated

refactor(core): clarify RunSystems() comment in README

e4a4b12

Miou-zora merged commit 40f6448 into main Apr 11, 2026
29 checks passed

Miou-zora deleted the 489-feature-rename-coreruncore-to-a-cleaner-name-run-or-start branch April 11, 2026 10:53

refactor(core): rename RunCore to Run for clarity by Miou-zora · Pull Request #581 · EngineSquared/EngineSquared · GitHub

Uh oh!

refactor(core): rename RunCore to Run for clarity - #581

refactor(core): rename RunCore to Run for clarity#581
Miou-zora merged 2 commits into
mainfrom
489-feature-rename-coreruncore-to-a-cleaner-name-run-or-start

Miou-zora commented Apr 11, 2026 •
edited by coderabbitai Bot
Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Apr 11, 2026 •
edited
Loading

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

refactor(core): rename RunCore to Run for clarity by Miou-zora · Pull Request #581 · EngineSquared/EngineSquared · GitHub

Uh oh!

refactor(core): rename RunCore to Run for clarity - #581

Conversation

Miou-zora commented Apr 11, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

Related Issues (Put "None" if there are no related issues)

Type of Change

Changes Made

Testing

Test Environment

Screenshots/Videos (Put "None" if there are no related issues)

Documentation

Checklist (Don't delete any options)

Breaking Changes (Put "None" if there are no related issues)

Additional Notes (Put "None" if there are no related issues)

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 11, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Miou-zora commented Apr 11, 2026 •
edited by coderabbitai Bot
Loading

coderabbitai Bot commented Apr 11, 2026 •
edited
Loading