Project feature warning system #31171

aaronfranke · 2019-08-07T05:08:23Z

(Note: This PR also increments the config version by necessity)

A mostly complete implementation of a feature warning system, implements and closes godotengine/godot-proposals#427, implements and closes godotengine/godot-proposals#237

EDIT: The screenshot is a bit outdated, since now there are more specific error messages available.

What works: Reading project features from project.godot, displaying unsupported features, warning when trying to open a project with unsupported features, changing the features to comply with currently supported and required features, and saving project features to project.godot.

This PR uses the new feature system for the following:

Saves the Godot version. This is in parallel to config_version, so as an example if 4.0 and 4.1 use the same config version then this system will show a warning when opening 4.0 projects in 4.1 and 4.1 projects in 4.0, but if 4.2 uses a higher config version then upgrading to 4.2 would be one-way.
- Users can also pin a project to a minor version or engine build if they wish, so 4.0.1 as an example.
Allows different builds of Godot to save feature tags to warn about the different features. In this PR it saves information about:
- Whether a project is using single-precision or doubles.
- Which renderer the project is using (Vulkan/GLES/etc).
- Whether a project is using C#.
- More can be added later if there's a need for any other feature tags.
Allows people to make custom builds of Godot and include a feature tag for it. Since this system just saves strings, even official builds of Godot can warn that they are missing features found in custom Godot forks.

reduz · 2021-08-31T13:46:54Z

@reduz Is that guaranteed to happen for 4.0?

Yes that is the idea, otherwise it would be a major compatibility breakage between 4.0 and 4.1.

Saves the Godot version. This is in parallel to config_version, so as an example if 4.0 and 4.1 use the same config version then this system will show a warning when opening 4.0 projects in 4.1 and 4.1 projects in 4.0, but if 4.2 uses a higher config version then upgrading to 4.2 would be one-way.

Not against a version check, this part may go through, but needs to be consulted with other contributors.

For the rest, I think using feature tags for this is not a good idea, because most of them are either irrelevant or platform dependent. IMO something more specialized is required for this situation. I think this needs to be something else more related to compilation flags (engine version, whether it uses doubles, etc) and not feature tags.

I suggest going back to the drawing board with this and create a new proposal.

Calinou · 2021-08-31T14:45:14Z

I think this needs to be something else more related to compilation flags (engine version, whether it uses doubles, etc) and not feature tags.

All the current feature tags are determined at compile-time, so double precision support could be a feature tag.

akien-mga · 2021-11-23T14:42:24Z

editor/project_manager.cpp

+					if (renderer_type == 0) {
+						project_features.push_back("Vulkan 1 Clustered");
+					} else if (renderer_type == 1) {
+						project_features.push_back("Vulkan 1 Mobile");
+					} else {
+						WARN_PRINT("Unknown renderer type. Please report this as a bug on GitHub.");


This shouldn't be hardcoded (it's no longer accurate either). I mean the numbers.

Do you happen to know where the enum is?

Looks like it's hard-coded here too (servers/rendering_server.cpp:2827):

GLOBAL_DEF_RST_BASIC("rendering/vulkan/rendering/back_end", 0); GLOBAL_DEF_RST_BASIC("rendering/vulkan/rendering/back_end.mobile", 1); ProjectSettings::get_singleton()->set_custom_property_info("rendering/vulkan/rendering/back_end", PropertyInfo(Variant::INT, "rendering/vulkan/rendering/back_end", PROPERTY_HINT_ENUM, "Forward Clustered (Supports Desktop Only),Forward Mobile (Supports Desktop and Mobile)"));

Hm right, I guess it's fine for now. We can rethink this once the OpenGL backend is ready and needs to be handled too.

editor/project_manager.cpp

core/config/project_settings.cpp

akien-mga

Approved in PR meeting.

We might want to iterate on the actual implementation to see what makes the most sense, but this is a good start to build upon.

aaronfranke · 2021-11-23T18:47:42Z

editor/project_manager.cpp

+		String warning_message = "";
+		for (int i = 0; i < unsupported_features.size(); i++) {
+			String feature = unsupported_features[i];
+			if (feature == "Double Precision") {
+				warning_message += TTR("Warning: This project uses double precision floats, but this version of\nGodot uses single precision floats. Opening this project may cause data loss.\n\n");
+				unsupported_features.remove(i);
+				i--;
+			} else if (feature == "C#") {
+				warning_message += TTR("Warning: This project uses C#, but this build of Godot does not have\nthe Mono module. If you proceed you will not be able to use any C# scripts.\n\n");
+				unsupported_features.remove(i);
+				i--;
+			} else if (feature.substr(0, 3).is_numeric()) {
+				warning_message += vformat(TTR("Warning: This project was built in Godot %s.\nOpening will upgrade or downgrade the project to Godot %s.\n\n"), Variant(feature), Variant(VERSION_BRANCH));
+				unsupported_features.remove(i);
+				i--;
+			}
+		}
+		if (!unsupported_features.is_empty()) {
+			String unsupported_features_str = Variant(unsupported_features).operator String().trim_prefix("[").trim_suffix("]");
+			warning_message += vformat(TTR("Warning: This project uses the following features not supported by this build of Godot:\n\n%s\n\n"), unsupported_features_str);
+		}
+		warning_message += TTR("Open anyway? Project will be modified.");


This code has been updated to have more specific error messages, but still have a fallback for anything not covered by those messages.

core/config/project_settings.cpp

akien-mga · 2021-11-24T16:31:25Z

You can remove me as co-author, it's not deserved for a style nitpick ;)

akien-mga · 2021-11-24T18:28:27Z

Thanks!

Chaosus added feature proposal topic:editor labels Aug 7, 2019

akien-mga added this to the 3.2 milestone Aug 8, 2019

aaronfranke force-pushed the feature-system branch 2 times, most recently from 3e7f755 to 2c16d18 Compare August 23, 2019 22:03

aaronfranke force-pushed the feature-system branch from 2c16d18 to 54eabac Compare September 9, 2019 01:23

aaronfranke mentioned this pull request Sep 15, 2019

Add sort and has methods to PackedArrays #32144

Merged

akien-mga modified the milestones: 3.2, 4.0 Oct 8, 2019

aaronfranke force-pushed the feature-system branch from 54eabac to ec0efa7 Compare December 14, 2019 06:06

aaronfranke mentioned this pull request Jan 16, 2020

Make upgrading Godot remove existing .mono and .import directories. #34427

Open

aaronfranke mentioned this pull request Jan 31, 2020

Add a system for storing, displaying, and warning about incompatible features in the Project Manager godotengine/godot-proposals#427

Closed

aaronfranke force-pushed the feature-system branch 2 times, most recently from 2610c82 to 683493f Compare March 23, 2020 07:20

aaronfranke force-pushed the feature-system branch 2 times, most recently from 76c42a0 to ce26ba2 Compare April 4, 2020 08:45

aaronfranke mentioned this pull request Apr 6, 2020

Consider always saving the rendering API name #37645

Open

aaronfranke force-pushed the feature-system branch from ce26ba2 to ac27514 Compare April 29, 2020 19:42

aaronfranke force-pushed the feature-system branch from ac27514 to bcdf4c7 Compare May 8, 2020 00:33

aaronfranke force-pushed the feature-system branch from bcdf4c7 to a77d79a Compare May 15, 2020 03:16

aaronfranke force-pushed the feature-system branch from a77d79a to 2a2dc52 Compare June 3, 2020 03:18

aaronfranke force-pushed the feature-system branch from 2a2dc52 to 32f30bb Compare June 17, 2020 03:19

aaronfranke force-pushed the feature-system branch 2 times, most recently from 151b1e7 to b2805b7 Compare July 7, 2020 18:56

aaronfranke changed the title ~~[WIP] Feature warning system~~ Feature warning system Jul 7, 2020

aaronfranke added for pr meeting needs testing labels Jul 7, 2020

aaronfranke force-pushed the feature-system branch 2 times, most recently from 656a851 to 59414b5 Compare July 24, 2020 20:48

aaronfranke changed the title ~~Feature warning system~~ Project feature warning system Jul 24, 2020

aaronfranke mentioned this pull request Sep 19, 2021

Save the exact Godot version number to project.godot and display it in the project manager godotengine/godot-proposals#237

Closed

aaronfranke force-pushed the feature-system branch from 6644764 to 43fe34f Compare October 10, 2021 05:01

aaronfranke force-pushed the feature-system branch from 43fe34f to 81b2676 Compare November 2, 2021 03:35

aaronfranke force-pushed the feature-system branch from 81b2676 to 6bd80e1 Compare November 13, 2021 03:25

akien-mga reviewed Nov 23, 2021

View reviewed changes

editor/project_manager.cpp Outdated Show resolved Hide resolved

akien-mga reviewed Nov 23, 2021

View reviewed changes

core/config/project_settings.cpp Outdated Show resolved Hide resolved

akien-mga approved these changes Nov 23, 2021

View reviewed changes

aaronfranke force-pushed the feature-system branch from 6bd80e1 to f64c2b7 Compare November 23, 2021 17:46

aaronfranke commented Nov 23, 2021

View reviewed changes

akien-mga approved these changes Nov 24, 2021

View reviewed changes

core/config/project_settings.cpp Outdated Show resolved Hide resolved

aaronfranke force-pushed the feature-system branch 2 times, most recently from 130fbbd to f986caf Compare November 24, 2021 16:19

Project feature warning system

e81c689

aaronfranke force-pushed the feature-system branch from f986caf to e81c689 Compare November 24, 2021 16:32

akien-mga merged commit e49b127 into godotengine:master Nov 24, 2021

aaronfranke deleted the feature-system branch November 24, 2021 18:57

aaronfranke mentioned this pull request Nov 25, 2021

Move logic for saving project features to ProjectSettings save_custom #55303

Merged

akien-mga mentioned this pull request Nov 25, 2021

Running debug process pollutes project.godot and forces to show a confirm dialog after closing #55302

Closed

aaronfranke mentioned this pull request Nov 25, 2021

Don't show errors when getting nonexistent settings #55309

Merged

and-rad mentioned this pull request Nov 25, 2021

Documentation pages to add or update for Godot 4.0 godotengine/godot-docs#5121

Open

41 tasks

raulsntos mentioned this pull request Dec 21, 2021

Show warning when project has been edited with a newer engine version godotengine/godot-proposals#3708

Closed

Calinou removed for pr meeting needs testing labels Jan 22, 2022

Calinou mentioned this pull request Apr 6, 2022

Add engine version number to project.godot file godotengine/godot-proposals#4355

Closed

akien-mga mentioned this pull request Jun 16, 2022

Add engine version number to resource, scene, and import files godotengine/godot-proposals#4534

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Project feature warning system #31171

Project feature warning system #31171

aaronfranke commented Aug 7, 2019 •

edited

Loading

reduz commented Aug 31, 2021

Calinou commented Aug 31, 2021 •

edited

Loading

akien-mga Nov 23, 2021 •

edited

Loading

aaronfranke Nov 23, 2021

aaronfranke Nov 23, 2021 •

edited

Loading

akien-mga Nov 23, 2021

akien-mga left a comment

aaronfranke Nov 23, 2021

akien-mga commented Nov 24, 2021

akien-mga commented Nov 24, 2021

Project feature warning system #31171

Project feature warning system #31171

Conversation

aaronfranke commented Aug 7, 2019 • edited Loading

reduz commented Aug 31, 2021

Calinou commented Aug 31, 2021 • edited Loading

akien-mga Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

aaronfranke Nov 23, 2021

Choose a reason for hiding this comment

aaronfranke Nov 23, 2021 • edited Loading

Choose a reason for hiding this comment

akien-mga Nov 23, 2021

Choose a reason for hiding this comment

akien-mga left a comment

Choose a reason for hiding this comment

aaronfranke Nov 23, 2021

Choose a reason for hiding this comment

akien-mga commented Nov 24, 2021

akien-mga commented Nov 24, 2021

aaronfranke commented Aug 7, 2019 •

edited

Loading

Calinou commented Aug 31, 2021 •

edited

Loading

akien-mga Nov 23, 2021 •

edited

Loading

aaronfranke Nov 23, 2021 •

edited

Loading