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

Add initial communication between game and editor #1320

Merged
merged 5 commits into from
Sep 28, 2024

Conversation

RiscadoA
Copy link
Member

@RiscadoA RiscadoA commented Sep 24, 2024

Description

Adds remote debugging to Cubos. Basically, the Cubos class now parses its incoming command line arguments.
If --debug <port> is passed, then, instead of immediately starting and running the game, it waits for a TCP connection on that port. When a connection is accepted, it listens for commands, such as:

  • run - makes the application resume running.
  • pause - makes the application stop and wait for further commands.
  • update <N> - makes the application run its update systems N times.
  • close - closes the application.
  • disconnect - closes the connection. The application starts listening again for another connection.

Also adds a simple UI tool to test this functionality inside Tesseratos.

Checklist

  • Self-review changes.
  • Evaluate impact on the documentation.
  • Ensure test coverage. (too troublesome to test right now, we don't have time for that in 0.4 😔)
  • Write new samples. (works with any existing sample)
  • 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
@RiscadoA RiscadoA added the S-Blocked Blocked on another issue or PR label Sep 24, 2024
@github-actions github-actions bot added B-Network Related to networking code B-Reflection labels 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-1320/
on branch gh-pages at 2024-09-28 05:52 UTC

Copy link

codecov bot commented Sep 24, 2024

Codecov Report

Attention: Patch coverage is 11.72414% with 128 lines in your changes missing coverage. Please review.

Project coverage is 37.41%. Comparing base (3e28551) to head (6732168).
Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
core/src/ecs/debugger.cpp 0.00% 77 Missing ⚠️
core/src/ecs/cubos.cpp 29.26% 29 Missing ⚠️
core/include/cubos/core/memory/opt.hpp 22.72% 17 Missing ⚠️
core/src/data/des/binary.cpp 0.00% 4 Missing ⚠️
core/src/data/ser/binary.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1320      +/-   ##
==========================================
- Coverage   37.51%   37.41%   -0.10%     
==========================================
  Files         409      410       +1     
  Lines       33059    33195     +136     
==========================================
+ Hits        12403    12421      +18     
- Misses      20656    20774     +118     

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

@RiscadoA RiscadoA force-pushed the 1303-add-initial-communication-between-game-and-editor branch 4 times, most recently from db5872a to d32e758 Compare September 27, 2024 15:57
@RiscadoA RiscadoA marked this pull request as ready for review September 27, 2024 15:59
@RiscadoA RiscadoA requested a review from a team as a code owner September 27, 2024 15:59
@RiscadoA RiscadoA removed the S-Blocked Blocked on another issue or PR label Sep 27, 2024
Copy link
Contributor

@kuukitenshi kuukitenshi left a comment

Choose a reason for hiding this comment

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

I didn't do an in-depth review because I don't wanna delay it, but after skimming through, it looks good to me.

@RiscadoA RiscadoA force-pushed the 1303-add-initial-communication-between-game-and-editor branch from d32e758 to a076aaf Compare September 27, 2024 18:58
@RiscadoA RiscadoA enabled auto-merge (rebase) September 27, 2024 19:11
@RiscadoA RiscadoA force-pushed the 1303-add-initial-communication-between-game-and-editor branch from a076aaf to 6732168 Compare September 28, 2024 05:51
@RiscadoA RiscadoA merged commit 4a09cb2 into main Sep 28, 2024
9 checks passed
@RiscadoA RiscadoA deleted the 1303-add-initial-communication-between-game-and-editor branch September 28, 2024 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add initial communication between game and editor
4 participants