Save color palette as resources to reuse later

[nongvantinh]

Close godotengine/godot-proposals#7946

The lack of a palette library slows down development time because swatches contain many colors that may not match the mood an artist is trying to achieve. This can hinder their workflow as they search for the right color within a large set of mostly irrelevant options.

Untitled.video.-.Made.with.Clipchamp.mp4

[AThousandShips]

This should use icons available at runtime, not editor icons, there are some appropriate ones available, and otherwise they should be added, this shouldn't depend on the editor

[fire]

I approve of allowing saving the color pallete from a usability team perspective.

[nongvantinh]

Update:

• Use FileDialog instead of EditorFileDialog.
• Save the palette in the user:// path instead of placing it in the project folder.
• Remove the Palette resource class because it doesn't need anymore.

@AThousandShips What do you mean when you say use icons available at runtime? I couldn't find the correct function to call.

[AThousandShips]

Icons available at runtime are those which aren't editor specific, meant in running projects not running the program itself sorry for confusion

Accidental approval

[nongvantinh]

Sorry for the annoying force push. I wasn't familiar with the TTR part. I need one more favor. I couldn't find the correct icon to use in the function get_theme_icon.

[AThousandShips]

If it isn't in the default theme scene/theme/icons/ then you can add them from the editor or create new ones, and then you need to add them to the default theme, see in scene/theme/default_theme.cpp for details

But I think the normal folder icon is sufficient

Gonna test this one probably tomorrow but code looks good, got some final remarks I'll add when I've tested it out

[Calinou]

I wonder if it should be possible to give a name to each color, and have the name displayed in a tooltip when hovering the color in the ColorPicker's swatch list.

It's common for designers to assign names to colors to make slightly different colors easier to distinguish from each other, or even to refer to them in natural language. If I refer to "lime 800" from Tailwind's color palette, you can immediately know it's #3f6212.

This could be left to a future PR, but we should make sure this feature can be implemented in the future without breaking compatibility (i.e. without changing the data structure in the resource).

[AThousandShips]

Tested and it works as expected, however I don't think the list of resources allowed makes sense, it should probably just limit to res and tres because it currently allows you to save as things like animtex and mesh, which don't make sense

Edit: correction, it shouldn't even be that, it should be some binary format dedicated to this, it doesn't actually store a res or tres file either, so that needs to be fixed

[Calinou]

I suggest using ConfigFile to save palettes as opposed to FileAccess, so you have a text format that is friendly to version control. I'd also give them a custom file extension so they can be targeted more specifically, e.g. cpl.

A similar approach is used for script editor syntax themes, which use a tet file extension.

[KoBeWi]

What is the replace() for? If you want to remove ending *, use trim_suffix("*").

[AThousandShips]

I'd also suggest (*) to match the scene tabs in the editor as well as the script editor

[nongvantinh]

I don't think it is related to the editor or script editor, and it might unnecessarily confuse users who keep pressing Ctrl+S to save changes, but the color picker doesn't respond and keeps showing the (*) on these editors.

[AThousandShips]

I don't see how that'd be any more or less confusing because of that

[nongvantinh]

When the palette has too many colors, it will overflow the screen. I need to wrap it inside a scroll container. However, should I wrap the entire color picker in a scroll container or only the palette? Any suggestions?

[KoBeWi]

I think only the palette, because it's foldable. Although if you simply put a ScrollContainer it will likely be too small. Not sure how to solve that.

[nongvantinh]

I could introduce a foldable left side panel to the color picker, which will have a height equal to the ColorPicker's height. With the space acquired, I could implement the ability to give a name to each color. Perhaps, I could also allow users to dynamically resize this panel.

With that, I could also allow users to load multiple palettes simultaneously.

Edit:

Please note, I have a personal workload that will end in August, which requires me to put all my effort into it. Therefore, I will take a break from this and come back when it's done.

[AThousandShips]

Suggested change

	options_menu->connect("id_pressed", callable_mp(this, &ColorPicker::_options_menu_cbk));
	options_menu->connect(SceneStringName(id_pressed), callable_mp(this, &ColorPicker::_options_menu_cbk));

New constant