Skip to content

NITWORK/DOCUMENTAION: rfc#94

Merged
guillaumeAbel merged 9 commits intodevfrom
doc/RB-120
Oct 15, 2023
Merged

NITWORK/DOCUMENTAION: rfc#94
guillaumeAbel merged 9 commits intodevfrom
doc/RB-120

Conversation

@Saverio976
Copy link
Copy Markdown
Collaborator

@Saverio976 Saverio976 commented Oct 14, 2023

MINOR

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Norm of the code has been respected
  • In what state is your pull request?
  • Ready to merge / Waiting a reviwer to see my work.
  • Work In Progress (WIP) / My work is not finish but i want daily reviews. (Draft)
  • CI Review / I want to see what the CI thinks of my work.
  • Need feedback / Just to have feedback on what i produced. (May not be merged)
  • What kind of change does this PR introduce? (You can choose multiple)
  • Bug fix
  • Feature request
  • New / Updated documentation
  • Testing CI ( Make the pull request in draft mode)
  • What is the current behavior? (link an issue based on the kind of change this pr introduce)

  • What is the new behavior (if this is a feature change)?

  • Other information:

Summary by CodeRabbit

  • Documentation: Introduced a new RFC document outlining the communication protocol for the R-Bus game, enhancing clarity for developers.
  • Refactor: Updated the n_nbAction_t type and the network packet structure, improving code readability and consistency.
  • New Feature: Added a CLASSIC value to the missileTypes_e enum, expanding gameplay options.
  • Refactor: Replaced unsigned int type with n_id_t in certain structures, streamlining code.
  • Refactor: Updated magick constants and modified the Packet object structure, enhancing code organization and clarity.

@Saverio976 Saverio976 added the documentation Improvements or additions to documentation label Oct 14, 2023
@Saverio976 Saverio976 self-assigned this Oct 14, 2023
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 14, 2023

Rate Limit Exceeded

@Saverio976 has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 12 minutes and 5 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, convert this PR to a draft and then mark it as ready for review again to re-trigger the review. Alternatively, you can push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per repository.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 8ec6d08 and 5b48f33.

Walkthrough

This pull request introduces a new RFC document for the R-Bus game's client-server communication protocol and modifies the network packet structure in the code. It also updates typedefs, enums, and struct definitions, and refactors some code for better readability and consistency.

Changes

File Path Summary
docs/network/rfc/RFC.md Introduced a new RFC document detailing the client-server communication protocol for the R-Bus game.
src/Nitwork/Nitwork.h Updated typedefs and struct definitions to align with the new network packet structure.
src/Client/Systems/Network/ClientNetwork.cpp Refactored code for better readability and consistency.
src/ECS/MessageTypes.h Added a new enum value and updated struct definitions.
src/Nitwork/NitworkServer.cpp Modified the initialization of a Packet object to align with the new network packet structure.

🐇

"In the land of code, where the shadows lie,

Changes come, under the cloudless sky.

With a hop, skip, and a jump, we refine,

Making our codebase, ever so fine. 🎉"


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • Mention @coderabbitai in any review comment for bot assistance.
  • Note: Review comments are made on code diffs or files, not on the PR overview.

Pause Incremental Reviews

  • Insert @coderabbitai: ignore in the PR description to halt the bot's ongoing reviews. Remove the line to resume.
  • Additionally, enter @coderabbitai pause to halt the bot's ongoing reviews as any issue or review comment. To
    resume reviews, enter @coderabbitai resume as any issue or review comment.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Details

Commits Files that changed from the base of the PR and between 37f68da and 86adf84.
Files selected for processing (2)
  • docs/network/rfc/RFC.md (1 hunks)
  • src/Nitwork/Nitwork.h (1 hunks)
Files skipped from review due to trivial changes (2)
  • docs/network/rfc/RFC.md
  • src/Nitwork/Nitwork.h

@Saverio976 Saverio976 marked this pull request as draft October 14, 2023 18:16
@Saverio976 Saverio976 marked this pull request as ready for review October 14, 2023 22:13
@Saverio976 Saverio976 changed the title NITWORK: Add first part of rfc NITWORK/DOCUMENTAION: rfc Oct 14, 2023
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 2

Details

Commits Files that changed from the base of the PR and between 86adf84 and 6113c66.
Files selected for processing (5)
  • docs/network/rfc/RFC.md (1 hunks)
  • src/Client/Systems/Network/ClientNetwork.cpp (2 hunks)
  • src/ECS/MessageTypes.h (2 hunks)
  • src/Nitwork/Nitwork.h (2 hunks)
  • src/Nitwork/NitworkServer.cpp (1 hunks)
Files skipped from review due to trivial changes (3)
  • src/ECS/MessageTypes.h
  • src/Nitwork/NitworkServer.cpp
  • docs/network/rfc/RFC.md (diff too large)
Additional comments (Suppressed): 4
src/Client/Systems/Network/ClientNetwork.cpp (1)
  • 99-102: The clock restart operation has been moved from line 114 in the old hunk to line 102 in the new hunk. This change means that the clock will restart even if the position of the player has not changed. If the intention was to restart the clock only when the player's position changes, this could be a potential issue. Please verify if this is the intended behavior.
src/Nitwork/Nitwork.h (3)
  • 24-25: The magic constants MAGICK_START_WAVE and MAGICK_POSITION_RELATIVE have been changed. Ensure that these changes are reflected wherever these constants are used in the codebase.

  • 36-38: The types of n_magick_t and n_nbAction_t have been changed from char and int to unsigned char. Ensure that these changes are reflected wherever these types are used in the codebase.

  • 202-207: The structure msgPositionRelativeBroadcast_s has been modified. The x and y fields have been replaced with a pos field of type struct position_relative_s. Ensure that these changes are reflected wherever this structure is used in the codebase.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Details

Commits Files that changed from the base of the PR and between 6113c66 and 8ec6d08.
Files selected for processing (1)
  • src/Nitwork/NitworkServer.cpp (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/Nitwork/NitworkServer.cpp

@guillaumeAbel guillaumeAbel merged commit 1c3c92e into dev Oct 15, 2023
@Saverio976 Saverio976 deleted the doc/RB-120 branch October 17, 2023 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants