Implement textual ext/subresource IDs. #50676

reduz · 2021-07-21T00:46:17Z

Implements godotengine/godot-proposals#471

Friendlier with version control.
Generates pseudo unique IDs, to minimize conflicts when merging, but still user readable (so, not UUID).
Eventually will also allow to have more precisely named sub-resources in imported files.
This will allow better reloading on changes (including resources already loaded) as well as better keeping track of changes on the DCC.
Keeps backward compatibility with the old formats.
Binary and text format version incremented to mark breakage in forward
compatibility.

How it looks:

[ext_resource path="res://icon2.png" type="Texture2D" id="1_ylvbm"]
[sub_resource type="SpriteFrames" id="SpriteFrames-a9ryz"]
...
frames = SubResource( "SpriteFrames-a9ryz" )
icon = ExtResource( "1_ylvbm" )

BEFORE MERGING: TEST WELL!! A BUG HERE WILL BREAK SCENE FILES, RESULTING IN DATA LOSS.

This can be backported to 3.x.

Bugsquad edit: This closes godotengine/godot-proposals#471 and closes #22226.

Calinou · 2021-07-21T00:47:33Z

cc @Wavesonics, who was implementing a feature like this at some point.

Zylann · 2021-07-21T00:55:40Z

Super-minor: could use _ instead of - so double-click will select the whole ID in most text editors?

reduz · 2021-07-21T01:04:31Z

@Zylann aknowledged

Wavesonics · 2021-07-21T04:50:11Z

This is great! I wounder if we could apply something similar to the Resource IDs, that would solve the other (lesser) half of the issue.

reduz · 2021-07-21T09:57:58Z

@Wavesonics It applies to the resource IDs already

akien-mga · 2021-07-21T14:25:07Z

Updated to use natural sorting of IDs (so 11_* > 2_*).

akien-mga · 2021-07-21T15:07:51Z

Example of how this looks like on a 3.x project (with #50693) when removing a Node that used an ext_resource:

diff --git a/menu/main_menu.tscn b/menu/main_menu.tscn
index 06d3c9a..89131b7 100644
--- a/menu/main_menu.tscn
+++ b/menu/main_menu.tscn
@@ -1,4 +1,4 @@
-[gd_scene load_steps=29 format=2]
+[gd_scene load_steps=28 format=2]
 
 [ext_resource path="res://menu/main_menu.gd" type="Script" id="1"]
 [ext_resource path="res://art/intro_sky_bg.png" type="Texture" id="2"]
@@ -9,7 +9,6 @@
 [ext_resource path="res://art/intro_logo.png" type="Texture" id="7"]
 [ext_resource path="res://art/intro_taptofly.png" type="Texture" id="8"]
 [ext_resource path="res://art/alpaca.png" type="Texture" id="9_kqlfj"]
-[ext_resource path="res://art/alpacocha_small.png" type="Texture" id="10_j67j6"]
 [ext_resource path="res://art/alpaquitas.png" type="Texture" id="11_j68oo"]
 [ext_resource path="res://art/arbol.png" type="Texture" id="12_nyfon"]
 [ext_resource path="res://new_noisetexture.res" type="Texture" id="13_jxnjk"]
@@ -409,9 +408,6 @@ margin_bottom = 40.0
 [node name="Sprite" type="Sprite" parent="Control"]
 texture = ExtResource( "9_kqlfj" )
 
-[node name="Sprite" type="Sprite" parent="."]
-texture = ExtResource( "10_j67j6" )
-
 [node name="Sprite2" type="Sprite" parent="."]
 texture = ExtResource( "11_j68oo" )

So no more reordering of all indices like shown in #22226.

starry-abyss · 2021-07-21T20:05:55Z

Will this allow (in future) to auto-correct references to assets in scripts, when the assets are renamed/moved?

reduz · 2021-07-21T20:39:01Z

@starry-abyss This is internal for scenes, I think what you are looking for is UUID support.

Error7Studios · 2021-07-22T03:32:58Z

related? godotengine/godot-proposals#2365

ignaloidas · 2021-07-22T10:51:26Z

On initial inspection everything works fine besides the default initial default_env.tres getting changed after creating a scene.

diff --git a/default_env.tres b/default_env.tres
index ddf6bb7..636a639 100644
--- a/default_env.tres
+++ b/default_env.tres
@@ -1,7 +1,7 @@
 [gd_resource type="Environment" load_steps=2 format=2]
 
-[sub_resource type="Sky" id=1]
+[sub_resource type="Sky" id="1"]
 
 [resource]
 background_mode = 2
-sky = SubResource( 1 )
+sky = SubResource( "1" )

I'm gonna go through some older code where we had some issues with merging and check whether the issues are gone a bit later.

core/io/resource.cpp

core/io/resource.h

core/io/resource_format_binary.cpp

* Friendlier with version control. * Generates pseudo unique IDs, to minimize conflicts when merging, but still user readable (so, not UUID). * Eventually will also allow to have more precisely named sub-resources in imported files. * This will allow better reloading on changes (including resources already loaded) as well as better keeping track of changes on the DCC. * Keeps backward compatibility with the old formats. * Binary and text format version incremented to mark breakage in forward compatibility.

akien-mga · 2021-07-22T17:39:52Z

Fixed issues pointed out by reviewers, and bumped the FORMAT_VERSION for both binary and text formats to mark the forward compatibility breakage.

akien-mga

Seems good to me. Let's get it merged and further tested in master.

reduz · 2021-07-22T17:55:03Z

Changes look good!

akien-mga · 2021-07-22T18:33:59Z

Thanks!

Wavesonics · 2021-07-22T18:36:15Z

Man this is a really big deal! Another step toward being able to use Godot in larger teams/projects!

knightofiam · 2021-08-19T03:58:55Z

Can this be backported into 3.4? 😁

Calinou · 2021-08-19T08:35:35Z

Can this be backported into 3.4? 😁

See #50693. If you want to help get it merged, test it locally on your project and report the results back on that PR 🙂

See #50693 (comment) for Windows builds of the above PR.

reduz requested a review from a team as a code owner July 21, 2021 00:46

Calinou added breaks compat enhancement topic:core labels Jul 21, 2021

Calinou added this to the 4.0 milestone Jul 21, 2021

Calinou added needs testing and removed breaks compat labels Jul 21, 2021

This was referenced Jul 21, 2021

Track all resources with a unique ID instead of a res:// path #15673

Closed

Editing scenes files (.tscn) in a git-friendly manner #22324

Closed

reduz force-pushed the textual-resource-ids branch from e50e650 to a540e1b Compare July 21, 2021 00:56

reduz changed the title ~~Implement textual subresource IDs.~~ Implement textual ext/subresource IDs. Jul 21, 2021

reduz force-pushed the textual-resource-ids branch 3 times, most recently from 74a1d30 to c76e600 Compare July 21, 2021 02:44

akien-mga force-pushed the textual-resource-ids branch from c76e600 to d9b123c Compare July 21, 2021 10:59

akien-mga mentioned this pull request Jul 21, 2021

[3.x] Implement textual ext/subresource IDs. #50693

Closed

akien-mga force-pushed the textual-resource-ids branch from d9b123c to fd19a50 Compare July 21, 2021 14:24

akien-mga force-pushed the textual-resource-ids branch from fd19a50 to 51a27b1 Compare July 21, 2021 14:32

AaronRecord reviewed Jul 22, 2021

View reviewed changes

core/io/resource.cpp Outdated Show resolved Hide resolved

core/io/resource.h Outdated Show resolved Hide resolved

core/io/resource_format_binary.cpp Outdated Show resolved Hide resolved

akien-mga force-pushed the textual-resource-ids branch from 51a27b1 to f727f55 Compare July 22, 2021 17:37

akien-mga force-pushed the textual-resource-ids branch from f727f55 to 75755be Compare July 22, 2021 17:38

akien-mga approved these changes Jul 22, 2021

View reviewed changes

akien-mga merged commit c2c82de into godotengine:master Jul 22, 2021

Calinou mentioned this pull request Nov 21, 2021

Grid map changing mesh library .tres sub resource ids when saving scene #55190

Open

fire mentioned this pull request Jan 3, 2022

Add a 'tracker' string to .tscn files (for preventing data loss in tool scenes) godotengine/godot-proposals#2365

Closed

Calinou removed the needs testing label Jan 3, 2022

KoBeWi mentioned this pull request Mar 24, 2022

Use GUID metadata instead of hardcoded paths godotengine/godot-proposals#4270

Closed

Mickeon mentioned this pull request Apr 14, 2022

New scene save system with JSON godotengine/godot-proposals#4400

Closed

Abb4 mentioned this pull request Aug 7, 2023

Verify that scene load issue is gone daniu54/earie-treasures#20

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement textual ext/subresource IDs. #50676

Implement textual ext/subresource IDs. #50676

reduz commented Jul 21, 2021 •

edited by akien-mga

Loading

Calinou commented Jul 21, 2021 •

edited

Loading

Zylann commented Jul 21, 2021

reduz commented Jul 21, 2021

Wavesonics commented Jul 21, 2021

reduz commented Jul 21, 2021

akien-mga commented Jul 21, 2021 •

edited

Loading

akien-mga commented Jul 21, 2021

starry-abyss commented Jul 21, 2021

reduz commented Jul 21, 2021

Error7Studios commented Jul 22, 2021

ignaloidas commented Jul 22, 2021

akien-mga commented Jul 22, 2021

akien-mga left a comment

reduz commented Jul 22, 2021

akien-mga commented Jul 22, 2021

Wavesonics commented Jul 22, 2021

knightofiam commented Aug 19, 2021

Calinou commented Aug 19, 2021 •

edited

Loading

Implement textual ext/subresource IDs. #50676

Implement textual ext/subresource IDs. #50676

Conversation

reduz commented Jul 21, 2021 • edited by akien-mga Loading

Calinou commented Jul 21, 2021 • edited Loading

Zylann commented Jul 21, 2021

reduz commented Jul 21, 2021

Wavesonics commented Jul 21, 2021

reduz commented Jul 21, 2021

akien-mga commented Jul 21, 2021 • edited Loading

akien-mga commented Jul 21, 2021

starry-abyss commented Jul 21, 2021

reduz commented Jul 21, 2021

Error7Studios commented Jul 22, 2021

ignaloidas commented Jul 22, 2021

akien-mga commented Jul 22, 2021

akien-mga left a comment

Choose a reason for hiding this comment

reduz commented Jul 22, 2021

akien-mga commented Jul 22, 2021

Wavesonics commented Jul 22, 2021

knightofiam commented Aug 19, 2021

Calinou commented Aug 19, 2021 • edited Loading

reduz commented Jul 21, 2021 •

edited by akien-mga

Loading

Calinou commented Jul 21, 2021 •

edited

Loading

akien-mga commented Jul 21, 2021 •

edited

Loading

Calinou commented Aug 19, 2021 •

edited

Loading