Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(tools): move most tools to the engine #1324

Merged
merged 1 commit into from
Oct 7, 2024

Conversation

RiscadoA
Copy link
Member

@RiscadoA RiscadoA commented Sep 24, 2024

Description

So this PR looks big and scary but it's nothing ground breaking - I didn't implement any features here.
I just moved most of the tools in Tesseratos to the engine, under the directory tools.

Previously, Tesseratos was a library, which meant we could just use its utilities in games (such as Scraps vs Zombies) by linking Tesseratos as a dependency.
With 0.3, Tesseratos became an actual executable, which meant its tools became inaccessible.
The goal here is to simply move the tools which can be useful even in a deployed game to the engine library itself, while keeping actual editor stuff, such as the asset explorer and scene editor, on the editor itself.

I had to change a lot of boring stuff, such as the namespaces of everything from tesseratos:: to cubos::engine::, and also the respective documentation. Also used the opportunity to reword some stuff better, and simplify the naming of some plugins.

Also, to make things easier for users, I added a toolsPlugin which simply adds all of the plugins in the new directory.

Checklist

  • Self-review changes.
  • Evaluate impact on the documentation. (I had to change a lot of stuff!)
  • Ensure test coverage. No new features.
  • Write new samples. No new features, although I added the tools to the CuboSurfers plugin.
  • Add entry to the changelog's unreleased section.

@RiscadoA RiscadoA added this to the 0.4 milestone Sep 24, 2024
@RiscadoA RiscadoA self-assigned this Sep 24, 2024
@RiscadoA RiscadoA linked an issue Sep 24, 2024 that may be closed by this pull request
@github-actions github-actions bot added the C-Code-Quality A section of code that is hard to understand or change label Sep 24, 2024
Copy link
Contributor

github-actions bot commented Sep 24, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/preview/pr-1324/
on branch gh-pages at 2024-10-07 12:14 UTC

@RiscadoA RiscadoA force-pushed the 1322-move-tools-from-tesseratos-to-the-engine branch from 780ecbe to 8653793 Compare September 24, 2024 14:36
@RiscadoA RiscadoA marked this pull request as ready for review September 24, 2024 14:36
@RiscadoA RiscadoA requested a review from a team as a code owner September 24, 2024 14:36
@RiscadoA RiscadoA enabled auto-merge (rebase) September 24, 2024 14:38
Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 0% with 164 lines in your changes missing coverage. Please review.

Project coverage is 40.84%. Comparing base (2ce0d0f) to head (30a6d02).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
engine/src/tools/play_pause/plugin.cpp 0.00% 24 Missing ⚠️
engine/src/tools/selection/plugin.cpp 0.00% 20 Missing ⚠️
engine/src/tools/world_inspector/plugin.cpp 0.00% 20 Missing ⚠️
engine/src/tools/transform_gizmo/plugin.cpp 0.00% 15 Missing ⚠️
engine/src/tools/plugin.cpp 0.00% 13 Missing ⚠️
engine/src/tools/toolbox/toolbox.cpp 0.00% 13 Missing ⚠️
engine/src/tools/toolbox/plugin.cpp 0.00% 12 Missing ⚠️
engine/src/tools/ecs_statistics/plugin.cpp 0.00% 11 Missing ⚠️
engine/src/tools/collider_gizmos/plugin.cpp 0.00% 9 Missing ⚠️
engine/src/tools/debug_camera/plugin.cpp 0.00% 7 Missing ⚠️
... and 5 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1324      +/-   ##
==========================================
- Coverage   42.13%   40.84%   -1.30%     
==========================================
  Files         413      430      +17     
  Lines       29476    30409     +933     
==========================================
  Hits        12421    12421              
- Misses      17055    17988     +933     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RiscadoA RiscadoA force-pushed the 1322-move-tools-from-tesseratos-to-the-engine branch from 8653793 to c4b8c6f Compare September 28, 2024 07:11
@RiscadoA RiscadoA force-pushed the 1322-move-tools-from-tesseratos-to-the-engine branch from c4b8c6f to f51baee Compare September 29, 2024 13:56
@RiscadoA
Copy link
Member Author

@Scarface1809 don't forget to approve with your main account

Copy link
Contributor

@Dageus Dageus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't familiar with how this was organized before, but these changes seem to centralize all the tools, making it easier to use them. lgtm

@RiscadoA RiscadoA force-pushed the 1322-move-tools-from-tesseratos-to-the-engine branch from f51baee to 30a6d02 Compare October 7, 2024 12:13
@RiscadoA RiscadoA merged commit ada20d7 into main Oct 7, 2024
9 checks passed
@RiscadoA RiscadoA deleted the 1322-move-tools-from-tesseratos-to-the-engine branch October 7, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Engine A-Tesseratos B-Tools C-Code-Quality A section of code that is hard to understand or change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move tools from Tesseratos to the engine
5 participants