Universal plugins [wip] #35432

RandomShaper · 2020-01-22T09:50:47Z

Goal

The main idea is creating a system that allows plugins to be installed into a specific project or globally (at the OS user level) so they are available for every project.

Remarks

Each commit adds a logical step on top of which others are built.
Given the big scope of this PR, it's better to review it on a per-commit basis.
Some of them (especially, the one marked with [f]) are meant to be squashed together before merging.
Feedback and testing is welcome!

Materials

Specification

Please read the full design document.

The most recent commit (Improve UX of universal plugins) is not covered by the design document. It does a number of changes (detailed in the full commit message) to make the feature as easy-to-use as possible).

Screenshots

Legacy Plugin is a legacy (model=1, the default) plugin at <project_dir>/addons/.
Universal Plugin A is a universal (model=2) plugin at <project_dir>/addons/ (project-level, available to this project only).
Universal Plugin B is a universal (model=2) plugin at <godot_config_dir>/addons/ (user-level, available to all projects).
Universal Plugin C is a universal (model=2) plugin packed as a PCK file at <godot_config_dir>/addons/ (user-level, available to all projects).

Plugin settings

Plugin creation dialog

Default plugin code

(The explanation is added only for model=2 plugins.)

File system dock

File dialog

Browsing resources

Directory dialog

This code is generously donated by IMVU.

Namely, move the drive dropdown to just the left of the path text box and don't include the former in the latter. This by itself improves the UX on Windows, but it sets the ground for the following changes. In the UNIX case, since its concept of drives is (ab)used to provide shortcuts to useful paths, its dropdown is kept at the original location.

Previously, a change was missed if it happened while the scan was in progress and already past the affected location. Also: - Consider the scan changes thread on termination, in addition to the full scan one - Add FS-reported hidden to the check for hidden by the editor file system

editor/plugin_config_dialog.cpp

HeadClot · 2020-01-22T23:59:32Z

When this gets committed to the main branch does this mean that we will need to update our plugins to account for this change to plugins? Just curious :)

vnen · 2020-01-23T01:41:49Z

When this gets committed to the main branch does this mean that we will need to update our plugins to account for this change to plugins? Just curious :)

According to the linked design document, old plugins still work the same way.

RandomShaper · 2020-01-23T08:34:09Z

According to the linked design document, old plugins still work the same way.

That's right. Anyone not ready or willing to use the new model will enjoy complete backwards compatibility.

groud · 2020-01-23T08:56:33Z

I think we should be able to display the scope of a plugin directly in the filesystem dock. That would avoid messing up with user-wide plugins in some case.

fire · 2020-01-23T08:57:30Z

There's CICD failures here https://travis-ci.org/godotengine/godot/builds/640402635

RandomShaper · 2020-01-23T08:59:07Z

I think we should be able to display the scope of a plugin directly in the filesystem dock. That would avoid messing up with user-wide plugins in some case.

Good idea. Right now the tooltip you get for children of addons:// gives information about where it is physically.

However, using a different color or folder icon would be nice. The plugin settings dialog is using the accent color for user-level. That "language" could be used there, too.

First, removed the notion of logical paths from the FS-specific classes so that they deal only with physical paths. Therefore, translating back and forth between the abstracted (like `res://...`) and the real one will happen in the base classes. They were already doing part of that work, but the split wasn't clear enough. On top of that, `(Dir/File)AccessResources` are introduced to be the ones specifically handling access to resources. `DirAccessResources` has the notion of drives, being `res://` the only one for the time being. `String::simplify_path()` is made simpler and more universal. `String::is_abs_path()` now also considers paths with a leading Windows drive.

Make the full engine and editor aware of the fact that resources are not necessarily located under `res://`.

- Add support for multiple `PackedData` instances - Enhance directory API - Fix `FileAccess::exists()` not checking for PackedData being disabled - Fix `DirAccessPack::change_dir()` to handle ".." properyly (before `simplify_path()` disallows it) - Allow absolute paths in existence checks

If the file name text field is made not-editable, it won't be tried to be changed, keeping any text that has been set to it externally.

Highlights: - `addons://` is introduced as a virtual resources drive. - Plugin creation dialog: - New model is the default option. - If created with new model, the default script contains an explanation about it. - Placeholders containing paths are adjusted to the model currently selected. - If on rescan an enabled plugin is found not to be the same (for instance, a plugin is copied into the project while a user-wide one of the same name is enabled), the old one is teared down and the new is started up, making the switch seamless. - If a legacy plugin is located in the editor settings, since that won't work, it's ignored and a warning about it is printed.

Makes it able to seamlessly jump between packed and non-packed locations. Therefore, this commits also reverts what the editor file system scan needed before this was done.

FS dock: - Disallow impossible drag & drop cases - Handle _Show in file manager_ gracefully for items in PCK - Handle move, rename and remove gracefully for items in PCK - Hide the _New folder/resource/script_ and _Edit dependencies_ context menu items for read-only folders (PCK or `addons://`) - Add _[PCK]_ to every PCK plugin's root name - Paint items in PCK as grayed out - Add an informative tooltip about the location for children of `addons://` `EditorDirDialog`: - Paint items in PCK as grayed out - Add _[PCK]_ to every PCK plugin's root - Disable the _Create folder_ button for read-only folders (PCK or `addons://`) - Disallow picking a read-only folder as a destination path `EditorFileDialog`: - Disallow create folder and delete items if read-only (PCK or `addons://`) - Disallow picking a read-only folder in save mode - Paint items in PCK as grayed out Other: - Force correct PCK filename when exporting a plugin

RandomShaper · 2020-03-06T12:54:01Z

Not much of general interest. Closing.

arkology · 2020-03-06T13:21:21Z

It'll be completely offtopic, but this is how Godot loses great features.

Xrayez · 2020-03-06T13:23:46Z

@RandomShaper I hope a particular implementation will be discussed at GIP at least.

I also wonder what's the real reason for closing the PR, was there any discussion regarding this particular implementation? Not all users follow IRC discussions. There's certainly a general interest in this.

akien-mga · 2020-03-06T13:50:42Z

I'm not sure why @RandomShaper's closing comment was so laconic, but to clarify, we discussed this at length at the past Godot Sprint in October 2019, and then again during GodotCon in February 2020. This is a wanted feature but not in its current form, which is needlessly complex (because of its flexibility, but flexibility comes at the cost of complexity, and goes against our guidelines).

A new proposal is expected building on this one, which keeps things simple while allowing having global editor plugins.

RandomShaper added feature proposal topic:core topic:editor needs testing labels Jan 22, 2020

RandomShaper added this to the 4.0 milestone Jan 22, 2020

RandomShaper requested review from akien-mga, groud and reduz January 22, 2020 09:50

RandomShaper requested review from bojidar-bg, hpvb and vnen as code owners January 22, 2020 09:50

Pedro J. Estébanez added 4 commits January 22, 2020 12:22

Encapsulate import settings path generation

227726f

Ignore hidden files and directoreis in find in files

ff57cee

RandomShaper force-pushed the universal_plugins branch from 7a87901 to c463a85 Compare January 22, 2020 11:27

YeldhamDev reviewed Jan 22, 2020

View reviewed changes

editor/plugin_config_dialog.cpp Outdated Show resolved Hide resolved

Pedro J. Estébanez added 6 commits January 23, 2020 10:16

Generalize resource access

a1f7d3a

Make the full engine and editor aware of the fact that resources are not necessarily located under `res://`.

Add ConfigFile::parse()

3e2fd8b

Fix VariantParser::StreamString EOF determination

96f349a

Implement pack unmounting

e7d203c

RandomShaper force-pushed the universal_plugins branch from c463a85 to 44c8263 Compare January 23, 2020 09:16

Add SIMPLE_PACK export mode

414d586

RandomShaper force-pushed the universal_plugins branch 2 times, most recently from f5164d1 to adf25a0 Compare January 23, 2020 11:10

Pedro J. Estébanez added 4 commits January 23, 2020 17:13

Allow Editor/FileDialog to force a file name

bf313e5

If the file name text field is made not-editable, it won't be tried to be changed, keeping any text that has been set to it externally.

Fully abstract DirAccessResources [f]

e1a133c

Makes it able to seamlessly jump between packed and non-packed locations. Therefore, this commits also reverts what the editor file system scan needed before this was done.

RandomShaper force-pushed the universal_plugins branch from adf25a0 to 9bab52d Compare January 23, 2020 16:13

nikhilCad mentioned this pull request Jan 27, 2020

Allow opening sprites and other files in external editor/default program godotengine/godot-proposals#328

Closed

RandomShaper changed the title ~~Universal plugins~~ Universal plugins [wip] Feb 10, 2020

RandomShaper closed this Mar 6, 2020

RandomShaper deleted the universal_plugins branch March 6, 2020 12:54

akien-mga added the archived label Mar 6, 2020

twaritwaikar mentioned this pull request Apr 19, 2020

Unrecognized by godot. godotengine/godot-git-plugin#29

Closed

arkology mentioned this pull request May 13, 2020

Add support for global plugins/universal addons godotengine/godot-proposals#831

Open

Vivraan mentioned this pull request Aug 7, 2020

Fix path resolution for Windows Symbolic Links godotengine/godot-proposals#1329

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Universal plugins [wip] #35432

Universal plugins [wip] #35432

RandomShaper commented Jan 22, 2020 •

edited

Loading

HeadClot commented Jan 22, 2020

vnen commented Jan 23, 2020

RandomShaper commented Jan 23, 2020

groud commented Jan 23, 2020

fire commented Jan 23, 2020

RandomShaper commented Jan 23, 2020

RandomShaper commented Mar 6, 2020

arkology commented Mar 6, 2020

Xrayez commented Mar 6, 2020

akien-mga commented Mar 6, 2020 •

edited

Loading

Universal plugins [wip] #35432

Universal plugins [wip] #35432

Conversation

RandomShaper commented Jan 22, 2020 • edited Loading

Goal

Remarks

Materials

Specification

Screenshots

Plugin settings

Plugin creation dialog

Default plugin code

File system dock

File dialog

Browsing resources

Directory dialog

HeadClot commented Jan 22, 2020

vnen commented Jan 23, 2020

RandomShaper commented Jan 23, 2020

groud commented Jan 23, 2020

fire commented Jan 23, 2020

RandomShaper commented Jan 23, 2020

RandomShaper commented Mar 6, 2020

arkology commented Mar 6, 2020

Xrayez commented Mar 6, 2020

akien-mga commented Mar 6, 2020 • edited Loading

RandomShaper commented Jan 22, 2020 •

edited

Loading

akien-mga commented Mar 6, 2020 •

edited

Loading