Improve the editor template workflow for users and devs #53957

fabriceci · 2021-10-18T12:56:15Z

Co-Authored-By: jmb462 [email protected]

This PR attempts to improve/rewrite the script template workflow to make the usage as easy/smooth as possible.

fix #36605
fix #28799
fix #44534
fix #46436
close godotengine/godot-proposals#1899

What are the main changes?

Built-in templates are in external file instead of hard-coded c++, they are no more mixed with user templates and can be updated
Templates are now linked to a node, when you create a script for a node, you will only see the templates for this node, or one of its parents.
Simplification and cleaning.

How it can be used by core dev

The original motivation was to provide a more relevant template for CharacterBody nodes in order to :
    - help to avoid the common error we see in issues (like forget to assign the result of move and slide in 3.x)
    - help to make the transition in 4.0 (act like a tutorial)
    - fast prototyping, you have a moving character in few seconds

default.template.mp4

How it works?

The template folders have the following structure

To add a template simply create a file in the correct folder (template_path/node_type/file.ext), that's it.

By default:

the name of the template file will be the name of the file
the description will be empty
the space indent will be 4
the template will not be use as default

You can customize the template info with metas at the begning of your templates. Metas starts with the single-line comment syntax of your language:

# meta-name: Basic movement
# meta-description: Classic movement for gravity games (platformer, ...)
# meta-default: true
# meta-space-indent: 4

Example of description:

It works exactly the same for built-in and user templates

Notes

When you create an editor plugin in c# you will have the basic structure for a plugin that I found in the doc. However there is a warning that pop up for now (I don't know why as I don't use c# & there was nothing before)
I wonder if the project template folder should not be fixed like the add-ons one (not changeable in the editor), to avoid the ifdef in gdscript.cpp

Calinou · 2021-10-18T13:14:09Z

the space indent will be 4

As per the GDScript style guide, indentation should use tabs by default. Or is this about templates being written with spaces instead of tabs (to convert from spaces to tabs)?

Official script templates should be indented with tabs, still.

aaronfranke

I recommend reading the GDScript style guide: https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_styleguide.html

modules/gdscript/editor_templates/CharacterBody2D/basic_mouv.gd

YuriSizov · 2021-10-18T13:19:57Z

Not sure from the changes if you handle this or not, but I think templates at the root of the template folder (like now) can be handled as Object or Node templates for backward compatibility.

PS. Also, did you call the two files basic_mouv on purpose? Looks like a typo, and we better use full qualified names in the engine anyway.

fabriceci · 2021-10-18T13:36:35Z

As per the GDScript style guide, indentation should use tabs by default. Or is this about templates being written with spaces instead of tabs (to convert from spaces to tabs)? Official script templates should be indented with tabs, still.

The parser will replace the tab and 4 spaces by _TS_ (previously %TS%) by default. If the user want to use 2 spaces indent in the templates; he can pass the information in the parser with this meta. The result will look like this:

In the end, the result of the indentation will be the one defined in the editor's configuration:

raulsntos

So is the replacement syntax changed from %BASE% to _BASE_? Is there a reason to use _ over %? It seems to me that _ could be conflicting with valid scripts.

modules/mono/editor_templates/plugin.cs

fabriceci · 2021-10-18T16:24:48Z

So is the replacement syntax changed from %BASE% to _BASE_? Is there a reason to use _ over %? It seems to me that _ could be conflicting with valid scripts.

@raulsntos Yes, if you use % %syntax you will have errors in your editor (godot or external) when you open/edit the template as this syntax is not allowed in the language:

Godot:

VS Code:

To avoid this I changed the syntax to a valid one. As this syntax only concerns templates, I don't think is an issue, it seems to me the lesser evil.

raulsntos · 2021-10-18T16:28:37Z

Good enough for me, I guess the chances of someone wanting to use a world like _CLASS_ in the output of the template are low.

fabriceci · 2021-10-18T16:32:11Z

I thought about doubling the underscore at one point __BASE__, then I thought that one was enough. But if anyone has a better idea, I'll take it.

jmb462 · 2021-10-18T16:59:05Z

Not sure from the changes if you handle this or not, but I think templates at the root of the template folder (like now) can be handled as Object or Node templates for backward compatibility.

I'm working with @fabriceci on this PR.
Following your comments, I've started implementing this, but I realized that it brings more problems than it solves.

If we consider old templates in old root template directory as Object derivated, they will be shown for all node even if they are not suitable to that node.

The new system ensure that proposed templates can be applied for this node and should not include non existing methods for the node selected.

Old template uses % delimited tags which need to be translated.
I think very few people are using the old user template. Those could really easily convert their templates ( % => _ and add # meta information if needed) and put it in folders that is suitable for their templates.

YuriSizov · 2021-10-18T17:01:54Z

If we consider old templates in old root template directory as Object derivated, they will be shown for all node even if they are not suitable to that node.

They are suitable for all nodes though, just not all objects. Which is why I mentioned both. But since the syntax for placeholders was changed, I guess this is already a compatibility breaking change.

jmb462 · 2021-10-18T17:08:30Z

They are suitable for all nodes though, just not all objects. Which is why I mentioned both. But since the syntax for placeholders was changed, I guess this is already a compatibility breaking change.

What I mean is if someone wrote a template suitable for all Control nodes (template include method calls from Control class) with the old system in the old root directory.

With the new system, we put it in a Control subfolder and it won't be proposed for Node2D or Node3D derivated nodes.

If this template is left in the root template directory and considered to be suitable for all Object, it will kill one of the avdandage of the new system (if a template is proposed, it is suitable).

pouleyKetchoupp

Amazing work!

I've left some comments about the physics templates and the general API in core, I'm not very familiar with specific script implementations.

modules/gdscript/editor_templates/CharacterBody2D/basic_movement.gd

core/object/script_language.h

core/object/script_language.cpp

KoBeWi · 2022-01-01T02:53:52Z

The dialog feels really cluttered now. I'd add separators here:

Also the Template dropdown could get disabled instead of disappearing when unchecking the "Use Template".

Also² you could add this template for EditorScript:

# meta-description: Basic editor script template
@tool
extends EditorScript

func _run():
    # Called when the script is executed (using File -> Run in Script Editor).
    pass

Other than that all looks fine now (still need to check the code).

jmb462 · 2022-01-02T15:23:39Z

The dialog has been reorganized. The template part is now more compact.
The dropdown doesn't disapear any more.
EditorScript template has been added for GDScript and C#.

KoBeWi · 2022-01-02T20:21:42Z

editor/script_create_dialog.cpp

+	// Update last used dictionaries
+	if (is_using_templates && !parent_name->get_text().begins_with("\"res:")) {
+		if (sinfo.origin == ScriptLanguage::TemplateLocation::TEMPLATE_PROJECT) {
+			// Save the last used template for this node into the project dictionnary.


Suggested change

// Save the last used template for this node into the project dictionnary.

// Save the last used template for this node into the project dictionary.

Misspelled dictionary. Same below.

Fixed. Was a mix-up with the french spelling...

KoBeWi · 2022-01-02T20:23:37Z

Disabled is redundant here; I see it's disabled.
It should say "Empty" or "No Template".

I get errors every time I open script create dialog:

jmb462 · 2022-01-02T20:48:59Z

Disabled is redundant here; I see it's disabled. It should say "Empty" or "No Template".

I get errors every time I open script create dialog.

Fixed. A test was missing before the first creation of the dictionary.

Co-Authored-By: jmb462 <[email protected]>

akien-mga · 2022-01-03T19:40:37Z

Thanks!

The script templates page wasn't updated after godotengine/godot#53957 The templates are now per node type and folder organization has changed. A few behaviours and configuration have also changed. Documenting based on current editor behaviour and source code HEAD. Fixes godotengine#5887

fabriceci added bug enhancement topic:editor labels Oct 18, 2021

fabriceci added this to the 4.0 milestone Oct 18, 2021

fabriceci requested a review from a team October 18, 2021 12:56

fabriceci requested review from a team as code owners October 18, 2021 12:56

aaronfranke reviewed Oct 18, 2021

View reviewed changes

YuriSizov added the usability label Oct 18, 2021

raulsntos reviewed Oct 18, 2021

View reviewed changes

modules/mono/editor_templates/plugin.cs Outdated Show resolved Hide resolved

modules/mono/editor_templates/plugin.cs Outdated Show resolved Hide resolved

aaronfranke self-requested a review October 18, 2021 19:28

pouleyKetchoupp suggested changes Oct 18, 2021

View reviewed changes

fabriceci force-pushed the new-template-workflow branch from eb2f101 to a512161 Compare October 19, 2021 09:07

fabriceci mentioned this pull request Oct 19, 2021

Change the default gravity values #53988

Closed

pouleyKetchoupp reviewed Oct 19, 2021

View reviewed changes

core/object/script_language.cpp Outdated Show resolved Hide resolved

fabriceci requested review from a team as code owners October 21, 2021 16:02

jmb462 force-pushed the new-template-workflow branch 5 times, most recently from 4b9a84f to 51e9047 Compare January 2, 2022 12:32

KoBeWi reviewed Jan 2, 2022

View reviewed changes

jmb462 force-pushed the new-template-workflow branch from 51e9047 to 4fe1e78 Compare January 2, 2022 20:44

Improve editor template workflow

9d5b807

Co-Authored-By: jmb462 <[email protected]>

jmb462 force-pushed the new-template-workflow branch from 4fe1e78 to 9d5b807 Compare January 2, 2022 20:52

KoBeWi approved these changes Jan 2, 2022

View reviewed changes

akien-mga approved these changes Jan 3, 2022

View reviewed changes

akien-mga merged commit 98b3ba1 into godotengine:master Jan 3, 2022

Chaosus mentioned this pull request Jan 4, 2022

Add a GDScript template for VisualShaderNodeCustom #56480

Merged

akien-mga mentioned this pull request Jan 11, 2022

Unable to compile master branch, scons ModuleNotFoundError #56652

Closed

KoBeWi mentioned this pull request Jun 22, 2022

Script templates page is outdated godotengine/godot-docs#5887

Closed

jynus mentioned this pull request Jul 24, 2022

Document new script template system for Godot 4.0 godotengine/godot-docs#5981

Merged

fabriceci deleted the new-template-workflow branch August 26, 2022 14:32

This was referenced Oct 30, 2022

Disabling script template is not remembered after editor restart #67988

Closed

Remember Template checkbox in Create Script Dialog #68045

Closed

KoBeWi mentioned this pull request Dec 1, 2022

Restore metadata to script create dialog #69443

Merged

raulsntos mentioned this pull request Jan 20, 2023

Template placeholder named %CLASS% for GDScript #71454

Closed

aaronfranke mentioned this pull request Feb 25, 2023

Improve Godot character controller template #73873

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the editor template workflow for users and devs #53957

Improve the editor template workflow for users and devs #53957

fabriceci commented Oct 18, 2021 •

edited

Loading

Calinou commented Oct 18, 2021 •

edited

Loading

aaronfranke left a comment

YuriSizov commented Oct 18, 2021 •

edited

Loading

fabriceci commented Oct 18, 2021

raulsntos left a comment

fabriceci commented Oct 18, 2021 •

edited

Loading

raulsntos commented Oct 18, 2021 •

edited

Loading

fabriceci commented Oct 18, 2021

jmb462 commented Oct 18, 2021

YuriSizov commented Oct 18, 2021 •

edited

Loading

jmb462 commented Oct 18, 2021

pouleyKetchoupp left a comment

KoBeWi commented Jan 1, 2022

jmb462 commented Jan 2, 2022

KoBeWi Jan 2, 2022

jmb462 Jan 2, 2022

KoBeWi commented Jan 2, 2022

jmb462 commented Jan 2, 2022

akien-mga commented Jan 3, 2022

	// Save the last used template for this node into the project dictionnary.
	// Save the last used template for this node into the project dictionary.

Improve the editor template workflow for users and devs #53957

Improve the editor template workflow for users and devs #53957

Conversation

fabriceci commented Oct 18, 2021 • edited Loading

What are the main changes?

How it can be used by core dev

How it works?

Notes

Calinou commented Oct 18, 2021 • edited Loading

aaronfranke left a comment

Choose a reason for hiding this comment

YuriSizov commented Oct 18, 2021 • edited Loading

fabriceci commented Oct 18, 2021

raulsntos left a comment

Choose a reason for hiding this comment

fabriceci commented Oct 18, 2021 • edited Loading

raulsntos commented Oct 18, 2021 • edited Loading

fabriceci commented Oct 18, 2021

jmb462 commented Oct 18, 2021

YuriSizov commented Oct 18, 2021 • edited Loading

jmb462 commented Oct 18, 2021

pouleyKetchoupp left a comment

Choose a reason for hiding this comment

KoBeWi commented Jan 1, 2022

jmb462 commented Jan 2, 2022

KoBeWi Jan 2, 2022

Choose a reason for hiding this comment

jmb462 Jan 2, 2022

Choose a reason for hiding this comment

KoBeWi commented Jan 2, 2022

jmb462 commented Jan 2, 2022

akien-mga commented Jan 3, 2022

fabriceci commented Oct 18, 2021 •

edited

Loading

Calinou commented Oct 18, 2021 •

edited

Loading

YuriSizov commented Oct 18, 2021 •

edited

Loading

fabriceci commented Oct 18, 2021 •

edited

Loading

raulsntos commented Oct 18, 2021 •

edited

Loading

YuriSizov commented Oct 18, 2021 •

edited

Loading