There is no documentation on how to use the Helix Swarm comment and UE source control integration feature added in UE 5.3.
Hello.
The feature I’m trying to use is the Helix Swarm and source control integration introduced in the UE 5.3 roadmap and release notes.
You can check about this at the link below:
The Review Tool introduced in 5.2 now has direct Swarm integration when using P4 as source control, so the diffs you perform from there will directly show the comments in the editor. You can have comments for each change made, but also leave global review notes. We use simple metadata tagging in Swarm to link the comment to the right section of the diff.
Added an optional integration with Helix Swarm that provides a way for users to view/post comments from the UE changelist review tool.
The 5.3 release notes and roadmap explain that simple metadata tagging in Swarm integrates Swarm’s comments with the source control diff tool.
We are using Swarm, and using this feature would be very helpful for us. However, I couldn’t find any information in the official documentation about the release notes and Diff tool on what metadata tags to use and how to use them.
For anyone who makes it here and is not seeing the swarm comment box in the review tool, there’s a small issue with the current engine code (as of 5.3.2) if you didn’t set up your perforce server with the default server name of “p4d1”. (ours is p4_1 instead for instance)
if you change the hard coded value of “p4d1=” (i.e. “p4_1=” in our case) in the function:
to the p4 server name you’re using, then it should allow the comments to show up. the metadata they are referencing gets added automatically to any comments you add in the editor review tool.
to find the p4 name you’re using you can breakpoint the line with “TicketStrings” and see what strings show up in there, should be of the format “IPAddress:ServerName=Username:Password”, it should hit it when you try to open the review tool in the editor. Make sure you change the chop int number to the length of your server name plus = sign from 5 farther down if it doesn’t match.
if you change this server name string value in the engine code and still can’t see the comments box in the review tool then you may need to go into perforce, top left Connection->Environment Settings->OK in order to fix your p4 config file that the editor reads from.
the review tool is accessible from the editor bottom right
I assume this p4 server name value will be part of some config you can change in later engine updates but this code change should work for people in the meantime.
hopefully this helps other people, took me a bit to debug it for my project
