Skip to content

📝 Scribe: Add XML documentation for RemoteAgents#91

Open
nt153133 wants to merge 2 commits into
mainfrom
scribe-document-remote-agents-18052957302561617665
Open

📝 Scribe: Add XML documentation for RemoteAgents#91
nt153133 wants to merge 2 commits into
mainfrom
scribe-document-remote-agents-18052957302561617665

Conversation

@nt153133

@nt153133 nt153133 commented Jul 2, 2026

Copy link
Copy Markdown
Owner

📝 Scribe: Add XML documentation for RemoteAgents

💡 What: Added XML documentation for AgentGoldSaucerInfo, AgentLookingForGroup, AgentWorldTravelSelect, and AgentFreeCompany.

🎯 Why: These remote agents interface directly with game memory and UI, but lacked clear documentation on their members and underlying memory logic. Providing this clarity helps maintainers understand the "what" and "why" behind the specific memory offsets and traversal logic.

🔬 Examples:

  • AgentWorldTravelSelect: Explained the region-specific skip logic (RB_TC vs. Global) for filtering the player's home world from the choice array.
  • AgentFreeCompany: Documented the roster pointer chain and member data strides (0x60 bytes per member) used to retrieve member names and online status.
  • AgentLookingForGroup: Clarified the usage of the recruitment comment string properties.

PR created automatically by Jules for task 18052957302561617665 started by @nt153133

- AgentGoldSaucerInfo
- AgentLookingForGroup
- AgentWorldTravelSelect
- AgentFreeCompany
- Associated structs (WorldChoice, FcAction)

Co-authored-by: nt153133 <[email protected]>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@nt153133

nt153133 commented Jul 6, 2026

Copy link
Copy Markdown
Owner Author

Currently has merge conflicts @jules

@google-labs-jules

Copy link
Copy Markdown
Contributor

Currently has merge conflicts @jules

Merged main and resolved the conflicts in AgentFreeCompany.cs and AgentLookingForGroup.cs. Keeping my more detailed Scribe documentation where it adds value (e.g., explaining memory strides and hierarchy traversal).

- AgentGoldSaucerInfo
- AgentLookingForGroup
- AgentWorldTravelSelect
- AgentFreeCompany
- Associated structs (WorldChoice, FcAction)

Co-authored-by: nt153133 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant