Debug game - vibe coded successfully by AngeloTadeucci · Pull Request #551 · MS2Community/Maple2

AngeloTadeucci · 2025-07-23T04:31:38Z

Added field details, player and field npcs details

Summary by CodeRabbit

New Features
- Introduced a comprehensive debug UI for field and actor inspection, including interactive panels for field information, actor lists, and detailed actor stats.
- Selecting a field renderer now automatically opens a corresponding debug window if not already open.
Bug Fixes
- Corrected mesh construction logic to ensure proper rendering of cube meshes.
Refactor
- Improved code clarity, encapsulation, and consistency across the debug graphics system.
- Updated string formatting in UI windows to use modern C# interpolated strings.
- Simplified internal logic and improved thread safety in debug window management.
Chores
- Registered additional types for dependency injection and improved error handling for unmapped keys in the debug UI.

coderabbitai · 2025-07-23T04:31:44Z

Walkthrough

This update introduces a comprehensive refactor and expansion of the debug graphics and UI system in the server debug game module. Major changes include a full-featured debug UI for field and actor inspection, improved thread safety, code clarity, and encapsulation. Several files are updated for consistency, error handling, and automatic debug window management.

Changes

File(s)	Change Summary
Maple2.Server.DebugGame/Graphics/Assets/CoreModels.cs	Fixed cube mesh triangle construction by correcting vertex indexing logic to use index buffer for accurate vertex selection.
Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs	Extensively refactored and expanded to provide interactive debug UI for field and actor inspection, including thread-safe window management, new rendering and update logic, and detailed actor panels.
Maple2.Server.DebugGame/Graphics/DebugFieldWindow.cs	Simplified initialization logic, clarified null assignments, and updated API usage from `ref` to `in` for certain method calls.
Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs	Refactored for improved encapsulation, thread safety, and code clarity; adjusted access modifiers, reordered resource initialization and cleanup, and updated resource management logic.
Maple2.Server.DebugGame/Graphics/ImGuiController.cs	Changed unmapped key behavior in `SilkKeyToImGui` from throwing exceptions to returning `ImGuiKey.None`.
Maple2.Server.DebugGame/Graphics/Ui/Windows/FieldListWindow.cs	Simplified property syntax, switched to interpolated strings, and added logic to auto-create field windows when selecting a field renderer.
Maple2.Server.DebugGame/Graphics/Ui/Windows/WindowListWindow.cs	Replaced all `string.Format` usages with C# interpolated strings in UI rendering logic.
Maple2.Server.DebugGame/Program.cs	Removed unnecessary `.ToString()` call for IP address and registered `TriggerCache` as a singleton in the Autofac container.

Sequence Diagram(s)

sequenceDiagram
participant User
participant DebugFieldWindow
participant DebugFieldRenderer
participant FieldListWindow
participant Context
User->>FieldListWindow: Selects a field renderer
FieldListWindow->>FieldListWindow: Calls AutoCreateFieldWindow(renderer)
FieldListWindow->>Context: Checks for existing DebugFieldWindow
alt No window exists
FieldListWindow->>Context: Calls FieldWindowOpened()
Context-->>FieldListWindow: Returns new DebugFieldWindow
FieldListWindow->>DebugFieldWindow: Sets ActiveRenderer
else Window exists
FieldListWindow->>DebugFieldWindow: Sets ActiveRenderer
end
DebugFieldWindow->>DebugFieldRenderer: Renders field and actor info

Estimated code review effort

4 (~90 minutes)

Possibly related PRs

fix: GRPC game ip #220: Updates Program.cs to remove .ToString() on Target.GrpcGameIp and configures AddChannelRequest usage, directly related to the same field and method usage.
Debug renderer #209: Introduces and implements the CoreModels class and mesh creation logic, which is directly affected by the vertex indexing fix in this PR.

Poem

In windows bright, the fields unfold,
With actors' tales and stats retold.
Debuggers hop with nimble care,
Inspecting cubes and data there.
A thread-safe warren, neat and new—
This bunny's code now hops for you!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f817327 and 38bbb4a.

📒 Files selected for processing (2)

Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs (1 hunks)
Maple2.Server.DebugGame/Graphics/Ui/Windows/FieldListWindow.cs (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

Maple2.Server.DebugGame/Graphics/Ui/Windows/FieldListWindow.cs
Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: build
GitHub Check: build

✨ Finishing Touches

📝 Generate Docstrings

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d54ce3 and f817327.

📒 Files selected for processing (8)

Maple2.Server.DebugGame/Graphics/Assets/CoreModels.cs (1 hunks)
Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs (1 hunks)
Maple2.Server.DebugGame/Graphics/DebugFieldWindow.cs (5 hunks)
Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs (1 hunks)
Maple2.Server.DebugGame/Graphics/ImGuiController.cs (1 hunks)
Maple2.Server.DebugGame/Graphics/Ui/Windows/FieldListWindow.cs (3 hunks)
Maple2.Server.DebugGame/Graphics/Ui/Windows/WindowListWindow.cs (2 hunks)
Maple2.Server.DebugGame/Program.cs (2 hunks)

🧠 Learnings (4)

Maple2.Server.DebugGame/Graphics/DebugFieldWindow.cs (6)

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-08-11T07:13:23.335Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-10-09T04:13:28.776Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Learnt from: mettaursp
PR: #270
File: Maple2.Server.DebugGame/Graphics/Scene/Camera.cs:15-17
Timestamp: 2024-10-09T04:13:28.776Z
Learning: In Camera.cs, the SetProperties method is intentionally left unimplemented because it's not necessary outside of the work-in-progress debug renderer.

Learnt from: mettaursp
PR: #270
File: Maple2.Server.DebugGame/Graphics/Scene/Camera.cs:15-17
Timestamp: 2024-09-30T04:17:39.756Z
Learning: In Camera.cs, the SetProperties method is intentionally left unimplemented because it's not necessary outside of the work-in-progress debug renderer.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs:286-294
Timestamp: 2024-08-11T06:52:42.080Z
Learning: The GetResourceRootPath method in DebugGraphicsContext is only called during initialization, and a non-cached result is desired for future update checks.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs:286-294
Timestamp: 2024-10-09T04:13:28.776Z
Learning: The GetResourceRootPath method in DebugGraphicsContext is only called during initialization, and a non-cached result is desired for future update checks.

Maple2.Server.DebugGame/Graphics/Ui/Windows/FieldListWindow.cs (2)

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-08-11T07:13:23.335Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-10-09T04:13:28.776Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs (2)

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-08-11T07:13:23.335Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-10-09T04:13:28.776Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Maple2.Server.DebugGame/Graphics/DebugGraphicsContext.cs (2)

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-08-11T07:13:23.335Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

Learnt from: mettaursp
PR: #209
File: Maple2.Server.DebugGame/Graphics/DebugFieldRenderer.cs:41-43
Timestamp: 2024-10-09T04:13:28.776Z
Learning: Currently, there are no unmanaged resources in the DebugFieldRenderer class of the Maple2 project.

🧰 Additional context used