Resonite-Issues icon indicating copy to clipboard operation
Resonite-Issues copied to clipboard

Please add a Comment node to protoflux

Open RobotCyclopsGirlNamePending opened this issue 7 months ago • 2 comments

Is your feature request related to a problem? Please describe.

There is no straightforward way to Comment flux nodes, and this makes organization and clarity a bit difficult, especially for inexperienced users. I know that users have come up with workarounds for this, but having a way to Comment flux in an official capacity would help a tremendous amount with creating flux code that is easy to diagnose and edit at a glance.

Describe the solution you'd like

I made a mockup Comment node in a video demonstration:

https://github.com/user-attachments/assets/38214526-7896-4809-8b72-390b15f11cfd

Note that this mockup is non-functional and the color of the tail has no meaning. I hadn't considered the importance of line colors when creating the mockup; I am an inexperienced user. Ideally, the user would be able to spawn a Comment node, type text into it, and attach the tail of it to the titlebar of any existing protoflux node. The user could remove the tail by cutting it with a protoflux tool, or could simply pack it in place connected to the node tree like any other node.

Describe alternatives you've considered

Redprint has existed for a while and has a code commenting system, but Redprint crashes my worlds frequently, and is a very complex solution to a simple problem. There are redprint alternatives, but even then, these are advanced flux organization systems that I would rather not have to rely on simply for commenting code.

I've also seen users use string input nodes as a workaround for the lack of comment nodes, but this doesn't pack in place without a bit of effort, and the comments obviously aren't going to attach to the relevant nodes as-is.

Additional Context

No response

Requesters

Resonite: "(  ̄ᴗ ̄ )" Name pending, call me "Smiley" for now.

semi related to #4140

Redd56 avatar May 25 '25 03:05 Redd56

related issue for those who like comments in all forms #2977

Dusty-Sprinkles avatar May 25 '25 03:05 Dusty-Sprinkles