Allow to override editor settings per project #69012

KoBeWi · 2022-11-22T16:18:36Z

This PR allows to override any editor setting for any project, so you can customize your editor per-project.

godot.windows.editor.dev.x86_64_49rzlQvaqS.mp4

Bugsquad edit, closes: Indentation settings should be in project settings #80763

Mickeon · 2022-11-22T17:05:26Z

To me it would make sense the text was either warning yellow or accent color. However, warning yellow would be akin to inherited properties in the Inspector, which is not quite the same concept. So, maybe the accent color, plus a symbol to the side of the Label, plus an additional paragraph to the tooltip explaining what is going on may be nice

KoBeWi · 2022-11-22T17:14:19Z

The dialog uses standard inspector, so not sure how to display custom stuff without making too many specific changes.

Mickeon · 2022-11-22T17:21:21Z

Well, what is it that you could do? To begin from something concrete.

RedMser · 2022-11-22T19:33:26Z

Some things I noticed:

Possible solutions for better override UX
1. As mentioned already, editor settings need some different styling if overridden (text color, ideally a button to jump to the corresponding override, maybe renaming the setting to Setting Name (overridden)?).
2. Maybe the "Editor Overrides" project settings category could show up as a tab in Editor Settings dialog? So next to "General" have another tab for "Project Overrides" maybe? So the user doesn't have to wrangle two dialogs, since you can easily jump from one tab to another (maybe automatically do this after creating the override even).
3. Below each editor setting that is overridden, show a second entry to edit the override's value directly (kinda like with the feature tag suffixes .debug etc.). Would most definitely need larger inspector changes to work properly, so let's file this under "future ideas for improvement".
Overridden settings should copy over the hint, hint string and documentation tooltip of the original editor setting.
~~Changing override value caused WARNING: Property not found: editor_overrides/interface/scene_tabs/display_close_button at: ProjectSettings::_get (core\config\project_settings.cpp:349) for me.~~ This also happens when working with custom project settings so I guess it's fine.
The editor overrides API should probably be made available for GDScript, so plugins can more easily specify editor overrides (as was one of the use cases mentioned in the proposal).

dalexeev · 2022-11-23T18:00:02Z

I think this is a good feature, but there are two remarks:

Two places to edit (Editor Settings and Project Settings), it looks confusing and not very user friendly. Even if these overrides are stored in project.godot (rather than, say, editor_settings_overrides.cfg), they should be hidden from the user.
Now the whole project settings section (editor/*) is not needed and should be moved to Editor Settings.

Mockup:

Mickeon · 2022-11-23T18:06:12Z

Now the whole project settings section (editor/*) is not needed and should be moved to Editor Settings.

One thing at the time.

The look of the mock-up is... kind of interesting, although I'm not sure it's ideal for this. It's not like you'll see different names for "Override for _" in one project, so it just ends up being redundant.

dalexeev · 2022-11-23T18:14:05Z

Another option is to use two columns for global settings and overrides for the current project, like in git gui:

It's probably better for UX (it's not obvious to everyone that setting names have a context menu), but more cluttered.

It's not like you'll see different names for "Override for _" in one project, so it just ends up being redundant.

It could just be "Override for current project".

Mickeon · 2023-10-05T17:52:10Z

The more warning settings are added, the more necessary this feature feels.

KoBeWi · 2024-08-05T22:35:26Z

editor/themes/editor_theme_manager.cpp

-		EditorSettings::get_singleton()->set_manually("interface/theme/preset", config.preset);
-		EditorSettings::get_singleton()->set_manually("interface/theme/accent_color", config.accent_color);
-		EditorSettings::get_singleton()->set_manually("interface/theme/base_color", config.base_color);
-		EditorSettings::get_singleton()->set_manually("interface/theme/contrast", config.contrast);
-		EditorSettings::get_singleton()->set_manually("interface/theme/draw_extra_borders", config.draw_extra_borders);


This made the overrides apply permanently. Not sure if it's safe to remove, but these settings are fetched a few lines above, so it's super unlikely they will get modified here. Unless I'm missing something.

KoBeWi · 2024-08-06T21:35:39Z

Ok this is what I came up with:

godot.windows.editor.dev.x86_64_Zsd29jRBgO.mp4

(true is value of the override)

Just pushed the changes. The overrides are functional, but the goto button is not working yet. Also code needs cleanup.

KoBeWi · 2024-08-14T19:48:15Z

Finished. Feel free to test and review.

AThousandShips

Will compile and test this tomorrow but the code looks good

AThousandShips · 2024-08-14T12:38:37Z

editor/editor_settings_dialog.cpp

+	override_button = memnew(Button);
+	override_button->set_tooltip_text(TTR("Override this setting for the current project."));
+	container->add_child(override_button);
+	override_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_create_override));


Suggested change

override_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_create_override));

override_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsPropertyWrapper::_create_override));

AThousandShips · 2024-08-14T12:38:45Z

editor/editor_settings_dialog.cpp

+	goto_button = memnew(Button);
+	goto_button->set_tooltip_text(TTR("Go to override in Project Settings."));
+	override_info->add_child(goto_button);
+	goto_button->connect(SNAME("pressed"), callable_mp(EditorNode::get_singleton(), &EditorNode::open_setting_override).bind(property), CONNECT_DEFERRED);


Suggested change

goto_button->connect(SNAME("pressed"), callable_mp(EditorNode::get_singleton(), &EditorNode::open_setting_override).bind(property), CONNECT_DEFERRED);

goto_button->connect(SceneStringName(pressed), callable_mp(EditorNode::get_singleton(), &EditorNode::open_setting_override).bind(property), CONNECT_DEFERRED);

AThousandShips · 2024-08-14T12:38:53Z

editor/editor_settings_dialog.cpp

+	remove_button = memnew(Button);
+	remove_button->set_tooltip_text(TTR("Remove this override."));
+	override_info->add_child(remove_button);
+	remove_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_remove_override));


Suggested change

remove_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_remove_override));

remove_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsPropertyWrapper::_remove_override));

AThousandShips · 2024-10-16T16:04:12Z

editor/project_settings_editor.cpp

+void ProjectSettingsEditor::popup_for_override(const String &p_override) {
+	popup_project_settings();
+	tab_container->set_current_tab(0);
+	general_settings_inspector->set_current_section("editor_overrides/" + p_override.get_slice("/", 0));


Suggested change

general_settings_inspector->set_current_section("editor_overrides/" + p_override.get_slice("/", 0));

general_settings_inspector->set_current_section(ProjectSettings::EDITOR_SETTING_OVERRIDE_PREFIX + p_override.get_slice("/", 0));

marcinn · 2024-10-16T20:34:18Z

I would gently ask about risky or very subjective personal preferences not related to a project, like background color, text color, gizmo colors, etc. If they are saved in the project.godot file and replace my preferences, is there any way I can overwrite them again? Please think about collaborative work.

I understand and like the ability to override many editor settings, but I'm not sure if I'll be able to keep my work environment settings that are not related to the project (which is usually shared with others). If not, I would like to have possibility to lock settings important for me (but not related to the project), or another layer of override - a kind of rc file, which I will drop inside project dir and add to gitignore.

Finally I think that overriding everything is a very dangerous change (exploits in shared/public repositories, security vulnerabilities). You can set paths to exe files in Editor Settings. I'm pretty sure that I will able to commit malware and run it on someone's host through Godot Editor.

EDIT: my proposal is to prepare a curated list of safe and relevant to a project settings (see #98235 as a starting point, which is, for now, unsafe too)

EDIT2: Excluding risky settings should not be a solution. Any new setting will be potentially risky. We should implement "deny all, allow some" pattern here.

EDIT3: adding safe overrides in [editor] setting of project.godot is a good place to store per-project, IMO.

Mickeon · 2024-10-16T20:45:22Z

I wonder how the override.cfg file behaves with this, to resolve the concern raised above

KoBeWi · 2024-10-16T21:59:18Z

I would gently ask about risky or very subjective personal preferences not related to a project, like background color, text color, gizmo colors, etc. If they are saved in the project.godot file and replace my preferences, is there any way I can overwrite them again? Please think about collaborative work.

Why would someone do that though? In collaborative work this stuff should be discussed in the team, so I expect people won't just randomly override other's settings. I mean, even right now you can e.g. disable or enable some GDScript warnings because you don't like them and this affects all team members.

I wonder how the override.cfg file behaves with this, to resolve the concern raised above

override.cfg should be supported normally, so a local file with overrides would be a solution if someone wants to have personal overrides for whatever reason. It can also "remove" overrides by setting their value to null.

Finally I think that overriding everything is a very dangerous change (exploits in shared/public repositories, security vulnerabilities). You can set paths to exe files in Editor Settings. I'm pretty sure that I will able to commit malware and run it on someone's host through Godot Editor.

Not sure what do you mean by that. It's already possible when you run a project from untrusted source. It can be a malicious tool script that runs in the main scene, or even a prepared Theme set as project's default. Running random projects is always a risk and this PR doesn't really make it any worse. Note that to run a malware executable, you'd need to distribute it together with the project.

marcinn · 2024-10-16T22:35:17Z

Why would someone do that though? I expect people won't just randomly override other's settings

I'd like too. But there are mistakes, jokes, attacks.

On the other side I'm using .vimrc which could be dangerous (but I haven't noticed issues, because nobody uses vim).
But vim has -Z (restricted) mode to avoid executing nasty things. It would be nice to have something similar...

It's already possible

Oh, you're right. Tool script with OS.execute is a even better attack vector. It can run anything just after auto reload (i.e. after switching to a malicious branch) :|

Note that to run a malware executable, you'd need to distribute it together with the project.

rm is on every host (as an example)

KoBeWi · 2024-10-16T23:24:09Z

I'd like too. But there are mistakes, jokes, attacks.

The overrides only apply for the specific project and can't permanently "damage" your editor settings. If you are worried about jokes/attacks within your own project, the same applies to any other content. E.g. someone can replace the main character with a clown, as a joke. I don't see how it is different from trolling by overriding editor settings.

But vim has -Z (restricted) mode to avoid executing nasty things. It would be nice to have something similar...

See godotengine/godot-proposals#5010

marcinn · 2024-10-16T23:35:54Z

See godotengine/godot-proposals#5010

Thanks. Subscribed.

I don't see how it is different from trolling by overriding editor settings

For me there is a difference between destroying my desk (overriding >my< preferences) and showing picture of a destroyed desk (a clown character).

AThousandShips · 2024-10-17T12:06:57Z

Tested and works as expected, one thing I noticed though was that the button to remove the override was hard to click, it appears to only be working when clicking exactly on the cross, which makes it hard to use, otherwise it seems to work well!

KoBeWi · 2024-10-17T12:25:49Z

That's the default button for deletable properties (same as e.g. in metadata), so it's unrelated to this PR.

kitbdev · 2024-10-31T23:57:29Z

Since the purpose of proposal is more about one user customizing the editor per project than using the same editor settings in a project with others, maybe the overridden editor settings should be saved separately from the project settings.
It could be in the Editor Settings folder or as a separate file in the .godot folder (similar to VSCode workspace settings). This way by default it is not shared with the rest of the project.

marcinn · 2024-11-01T00:33:48Z

Since the purpose of proposal is more about one user customizing the editor per project than using the same editor settings in a project with others, maybe the overridden editor settings should be saved separately from the project settings.

For me, there are two cases:

project settings related to coding standards (indentation, other linting rules, etc)
user's private settings related to the project

The latter is not necessary at all - private settings are saved in editor settings already, and they are mostly global (cross project). Because our preferences (subjective settings) are generally same for all projects.

The whole thing is about settings important for collaborative work, which sometimes are related to the editor. IMHO some editor settings should be overridden by project settings. In the other words - in such cases the code editor should use project settings at highest priority. If this is not set in the project settings, the code editor should use the editor settings.

For your case (override your private preferences in project, just for you) the proposed 'override.cfg' will work if you add this file to .gitignore. But you will not be able to store code-related settings.

That's why I'm still not sure if these settings should be combined in one file. But yes, when used carefully it will fit our needs in most cases.

KoBeWi · 2024-11-02T12:47:12Z

maybe the overridden editor settings should be saved separately from the project settings.

That would require adding another hard-coded file in the project's main directory.

marcinn · 2024-11-02T13:11:36Z

That would require adding another hard-coded file in the project's main directory.

There is already override.cfg. The code-related settings could be saved in project.godot.

Having both we can achieve flexibility. Use cases:

override.cfg in git - for those who will override any settings per project, probably one-man-armies
override.cfg added to .gitignore - for those who want custom editor settings, but the project team is larger than John Rambo
code settings in project.godot - for those who want to customize code settings per project and want to set custom editor settings per project (p.2 - override.cfg w/gitignore); or for those who want just to configure important settings for collaborative work; (priority: code-related settings in project.godot < override.cfg < editor settings)

P1 and p2 will be solved by this PR. But having just only override.cfg will prevent from achieving p3.

Thanks, have a good day.

marcinn · 2024-12-25T00:35:22Z

(Not directly related to the issue)
Another example of editor settings, which should never be saved as a project setting, is export_path from export presets:

Every single export is trying to make changes in the repo.

KoBeWi · 2024-12-25T09:19:39Z

Export path is not a setting.
Why would it change though? Usually you export to the same path.

arkology · 2025-01-30T15:13:37Z

Most likely with this PR it will be possible to implement godotengine/godot-proposals#827 without overengineered hacks, just by 1) exposing feature profile as ordinary editor settings and 2) adding an option to replace pathes in settings with res:// (to be friendly for collaborative work on project)

KoBeWi added feature proposal topic:editor labels Nov 22, 2022

KoBeWi added this to the 4.x milestone Nov 22, 2022

KoBeWi requested a review from a team as a code owner November 22, 2022 16:18

This comment was marked as resolved.

Sign in to view

KoBeWi force-pushed the settings_of_editor_project branch from a58fc36 to e552960 Compare November 22, 2022 16:24

KoBeWi mentioned this pull request Nov 23, 2022

Rearrange editor/naming/* project settings #65137

Merged

dalexeev mentioned this pull request Jan 31, 2023

interface/editors/default_signal_callback_name not working #72391

Closed

KoBeWi mentioned this pull request Aug 18, 2023

Indentation settings should be in project settings #80763

Open

KoBeWi mentioned this pull request Oct 5, 2023

Disable the blend file import setting support by default, to prevent the startup warning godotengine/godot-proposals#7827

Closed

KoBeWi force-pushed the settings_of_editor_project branch from e552960 to 62831b4 Compare October 5, 2023 17:21

KoBeWi force-pushed the settings_of_editor_project branch from 62831b4 to 8ce35e8 Compare August 5, 2024 22:33

KoBeWi requested review from a team as code owners August 5, 2024 22:33

KoBeWi commented Aug 5, 2024

View reviewed changes

KoBeWi force-pushed the settings_of_editor_project branch from 8ce35e8 to 3376148 Compare August 6, 2024 21:35

KoBeWi requested a review from a team as a code owner August 6, 2024 21:35

KoBeWi force-pushed the settings_of_editor_project branch 2 times, most recently from 55096fb to 7f5ba1f Compare August 14, 2024 19:33

KoBeWi force-pushed the settings_of_editor_project branch from 7f5ba1f to ba247bc Compare August 14, 2024 19:48

AThousandShips mentioned this pull request Oct 16, 2024

Implement editor indent settings per project (type and size) #98235

Draft

KoBeWi modified the milestones: 4.x, 4.4 Oct 16, 2024

AThousandShips approved these changes Oct 16, 2024

View reviewed changes

KoBeWi force-pushed the settings_of_editor_project branch from 8257de2 to 0b7c6e6 Compare October 16, 2024 22:27

KoBeWi requested a review from a team as a code owner October 16, 2024 22:27

akien-mga mentioned this pull request Nov 14, 2024

Show a warning dialog when saving a large text-based scene #53679

Open

2 tasks

Repiteo added the topic:core label Nov 25, 2024

Repiteo removed the request for review from a team November 25, 2024 23:25

akien-mga self-requested a review December 17, 2024 20:33

Allow to override editor settings per project

79caf22

KoBeWi force-pushed the settings_of_editor_project branch from 0b7c6e6 to 79caf22 Compare December 25, 2024 09:30

akien-mga modified the milestones: 4.4, 4.5 Feb 12, 2025

KoBeWi mentioned this pull request Feb 12, 2025

Improve 3D editor's preview sun and environment UX #102751

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to override editor settings per project #69012

Allow to override editor settings per project #69012

KoBeWi commented Nov 22, 2022 •

edited by AThousandShips

Loading

This comment was marked as resolved.

Mickeon commented Nov 22, 2022

KoBeWi commented Nov 22, 2022

Mickeon commented Nov 22, 2022

RedMser commented Nov 22, 2022 •

edited

Loading

dalexeev commented Nov 23, 2022 •

edited

Loading

Mickeon commented Nov 23, 2022

dalexeev commented Nov 23, 2022 •

edited

Loading

Mickeon commented Oct 5, 2023

KoBeWi Aug 5, 2024

KoBeWi commented Aug 6, 2024 •

edited

Loading

KoBeWi commented Aug 14, 2024

AThousandShips left a comment •

edited

Loading

AThousandShips Aug 14, 2024

AThousandShips Aug 14, 2024

AThousandShips Aug 14, 2024

AThousandShips Oct 16, 2024

marcinn commented Oct 16, 2024 •

edited

Loading

Mickeon commented Oct 16, 2024

KoBeWi commented Oct 16, 2024

marcinn commented Oct 16, 2024 •

edited

Loading

KoBeWi commented Oct 16, 2024

marcinn commented Oct 16, 2024

AThousandShips commented Oct 17, 2024

KoBeWi commented Oct 17, 2024

kitbdev commented Oct 31, 2024

marcinn commented Nov 1, 2024

KoBeWi commented Nov 2, 2024

marcinn commented Nov 2, 2024

marcinn commented Dec 25, 2024

KoBeWi commented Dec 25, 2024

arkology commented Jan 30, 2025

	override_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_create_override));
	override_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsPropertyWrapper::_create_override));

	goto_button->connect(SNAME("pressed"), callable_mp(EditorNode::get_singleton(), &EditorNode::open_setting_override).bind(property), CONNECT_DEFERRED);
	goto_button->connect(SceneStringName(pressed), callable_mp(EditorNode::get_singleton(), &EditorNode::open_setting_override).bind(property), CONNECT_DEFERRED);

	remove_button->connect(SNAME("pressed"), callable_mp(this, &EditorSettingsPropertyWrapper::_remove_override));
	remove_button->connect(SceneStringName(pressed), callable_mp(this, &EditorSettingsPropertyWrapper::_remove_override));

	general_settings_inspector->set_current_section("editor_overrides/" + p_override.get_slice("/", 0));
	general_settings_inspector->set_current_section(ProjectSettings::EDITOR_SETTING_OVERRIDE_PREFIX + p_override.get_slice("/", 0));

Allow to override editor settings per project #69012

Are you sure you want to change the base?

Allow to override editor settings per project #69012

Conversation

KoBeWi commented Nov 22, 2022 • edited by AThousandShips Loading

This comment was marked as resolved.

Mickeon commented Nov 22, 2022

KoBeWi commented Nov 22, 2022

Mickeon commented Nov 22, 2022

RedMser commented Nov 22, 2022 • edited Loading

dalexeev commented Nov 23, 2022 • edited Loading

Mickeon commented Nov 23, 2022

dalexeev commented Nov 23, 2022 • edited Loading

Mickeon commented Oct 5, 2023

KoBeWi Aug 5, 2024

Choose a reason for hiding this comment

KoBeWi commented Aug 6, 2024 • edited Loading

KoBeWi commented Aug 14, 2024

AThousandShips left a comment • edited Loading

Choose a reason for hiding this comment

AThousandShips Aug 14, 2024

Choose a reason for hiding this comment

AThousandShips Aug 14, 2024

Choose a reason for hiding this comment

AThousandShips Aug 14, 2024

Choose a reason for hiding this comment

AThousandShips Oct 16, 2024

Choose a reason for hiding this comment

marcinn commented Oct 16, 2024 • edited Loading

Mickeon commented Oct 16, 2024

KoBeWi commented Oct 16, 2024

marcinn commented Oct 16, 2024 • edited Loading

KoBeWi commented Oct 16, 2024

marcinn commented Oct 16, 2024

AThousandShips commented Oct 17, 2024

KoBeWi commented Oct 17, 2024

kitbdev commented Oct 31, 2024

marcinn commented Nov 1, 2024

KoBeWi commented Nov 2, 2024

marcinn commented Nov 2, 2024

marcinn commented Dec 25, 2024

KoBeWi commented Dec 25, 2024

arkology commented Jan 30, 2025

KoBeWi commented Nov 22, 2022 •

edited by AThousandShips

Loading

RedMser commented Nov 22, 2022 •

edited

Loading

dalexeev commented Nov 23, 2022 •

edited

Loading

dalexeev commented Nov 23, 2022 •

edited

Loading

KoBeWi commented Aug 6, 2024 •

edited

Loading

AThousandShips left a comment •

edited

Loading

marcinn commented Oct 16, 2024 •

edited

Loading

marcinn commented Oct 16, 2024 •

edited

Loading