Godot Project Breakdown

Godot Project Breakdown 🤖

This is an VSCode extension that gets all .gd files in your Godot 3.X project , analyze them and gives a overview of all of them in a single file.

For each .gd file, it shows its private or public* variables and methods, defined signals, node references and enums.

* Private and public fields do not exist (at least at the moment) in gdscript, but if you use the prefix “_” to differentiate private fields (using “_”) from public (without “_”), it will take it into account.*

Reasons & Motivation

I made this extension for myself, to easily track and update every change in my project, so I could easily manage/update my project documentation (in my case, an UML diagram for my game). Instead of keeping track of every change manually, I just generate a new file, compare it to the previous version (using version control), and effectively update my documentation.

I released the extension just in case is helpful for somebody else.

Usage 🔧

1. Download latest version and install it

2. To install the .vsix files, go to extensions -> ... -> "Install from vsix"

   

   
   

3. Open command palette (F1)

4. Type Generate breakdown file

5. Execute command

6. Done! 🥳

Extension options ⚙

The result file is highly customizable to suit your needs. You can specify wich data to show, in wich order, and how.

Most options are self explanatory with its setting’s description. But some of them:

• godotProjectBreakdown.file.order This is one of the most important settings. Is a string that specifies the data to show and the order. Its default value is f# p ne svm

• godotProjectBreakdown.file.sortScriptsBy Allows you to sort the scripts by their path, name or extended node/script.
• godotProjectBreakdown.separator.{...} A string that allows you to add a custom header for each property.
• godotProjectBreakdown.prefix.{...} Allows you to add a custom prefix for each property.
• godotProjectBreakdown.file.ignoreFolders A Glob Pattern for ignoring folders/files that you don’t want to show in the breakdown file.

Its default value is "**/addons/**", wich means that will ignore files on anny “addons” folder.

• godotProjectBreakdown.file.showEnumValues A bool for showing (true) or not (false) the enum values for each enum.

Possible future improvements

• Analyze all the .tscn files in the project for getting more information, like… signals connected via editor.

• Maybe I’ll upload the extension into the vscode marketplace in the future.

FAQ

Which is the current state of the extension?

The extension was made originally for Godot 3.X.

At the moment I’m not continuing with the future development of this extension. It was my first (and only) VSCode extension and at the time I’m writing this (5 years after I made the extension), tools changed (TypeScript changed, VSCode Extensions’ API changed, Godot changed, etc.) and I don’t have the time, energy and motivation for continuing with this.

Logo license ©

The extension logo uses and modifies the original Godot logo by Andrea Calabró.

Its License: Godot Logo (C) Andrea Calabró Distributed under the terms of the Creative Commons Attribution License version 3.0 (CC-BY 3.0) https://creativecommons.org/licenses/by/3.0/legalcode.

Contact