Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Ericdowney/SignalVisualizer

A plugin for Godot 4.x. SignalVisualizer displays the current scene's signals and connections in a easy to read graph and tree dock.
https://github.com/Ericdowney/SignalVisualizer

Last synced: 6 days ago
JSON representation

A plugin for Godot 4.x. SignalVisualizer displays the current scene's signals and connections in a easy to read graph and tree dock.

Host: GitHub
URL: https://github.com/Ericdowney/SignalVisualizer
Owner: Ericdowney
License: mit
Created: 2023-08-24T21:32:17.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-05-23T01:14:41.000Z (6 months ago)
Last Synced: 2024-05-23T01:48:55.100Z (6 months ago)
Language: GDScript
Size: 2.56 MB
Stars: 192
Watchers: 6
Forks: 5
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-godot - SignalVisualizer - Displays the current scene's signals and connections in a easy to read graph and tree dock (Godot 4.x). (Plugins and scripts / 3D)

README

Signal

[![Static Badge](https://img.shields.io/badge/YouTube-red?style=for-the-badge&logo=youtube&logoColor=white)
](https://www.youtube.com/@minigamedev)
[![Static Badge](https://img.shields.io/badge/Godot%20Asset%20Library-blue?style=for-the-badge)
](https://godotengine.org/asset-library/asset/2067)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/110860230443653069?domain=https%3A%2F%2Fmastodon.gamedev.place&style=for-the-badge)](https://mastodon.gamedev.place/@minigamedev)
[![Static Badge](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)
](https://github.com/Ericdowney/SignalVisualizer/blob/main/LICENSE)

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C0T61WG)

A plugin for Godot 4.x. SignalVisualizer displays the current scene's signals and connections in a easy to read graph and tree dock.

![Signal Visualizer plugin running Godot 4.x](./images/SignalVisualizerDemo.png)

## YouTube

### Visualization

[![Signal Visualizer Demo Video](https://img.youtube.com/vi/eCWlVX9pwGU/0.jpg)](https://www.youtube.com/watch?v=eCWlVX9pwGU)

## Installation

The SignalVisualizer plugin can be installed from source or the Godot Asset Library.

### Godot Asset Library Installation

1. In Godot's AssetLib tab, search for SignalVisualizer
1. Download & Install

[Godot Asset Library: SignalVisualizer](https://godotengine.org/asset-library/asset/2067)

### Installation via Github

1. Download the repo
2. Copy the `addons/SignalVisualizer` directory to your project's `res://addons/` directory.
3. Enable the plugin under Project Settings -> Plugins

![Plugins Tab in Godot Project Settings](./images/PluginScreenshot.png)

4. The `Signal Visualizer` tab will display in the bottom dock region.

![Godot 4.x bottom dock displaying Signal Visualizer tab](./images/SignalVisualizerDockScreenshot.png)

5. The `Signal Debugger` tab will display as a new panel in the Debugger dock.

![Godot 4.x bottom dock displaying Signal Debugger panel](./images/SignalDebuggerPanel.png)

## Usage

Signal Visualizer

Signal Visualizer will create a signal graph by mapping the signals in the current scene in the Godot editor. The bottom dock uses the built-in `GraphEdit` and `Tree` nodes to display the signal graph. Only signals with the flag of `CONNECT_PERSIST` will be displayed in the signal graph. In addition, all nodes that begin with `@` in the name will be ignored.

1. With your scene open in the editor, open the bottom dock.
2. In Signal Visualizer's top toolbar, click "Generate Graph"

![Signal Visualizer plugin toolbar. Clear graph and Generate graph buttons.](./images/SignalVisualizerToolbarScreenshot.png)

#### Arrange Nodes Toggle

The "Arrange Nodes" toggle enables and disables automatic node arrangement when generating the graph. When enabled, `GraphEdit`'s `arrange_nodes()` function will be called once all graph nodes are generated.

#### Signal Details Toggle

The "Signal Details" toggle enables and disables expanded formatting described below. When disabled, only the signal's name and corresponding function will be displayed in the graph nodes connections.

#### Opening Signals in Source

The "Open" button that displays next to a signal's connected function will open the corresponding source file at the function's line number.

#### Format

In the signal graph and tree, the format is as follows:

##### Outgoing Signal

```
Signal -> Connected Node
```

![Player Node Outgoing Signals](./images/OutgoingSignalScreenshot%20.png)

##### Incoming Signal

```
Signal::Callable Method
```

![GameUI Node Incoming Signals](./images/IncomingSignalScreenshot.png)

Signal Debugger

The Signal Debugger connects to a running scene instance to allow for automatic logging of signals. This alleviates the need to add `print` statements to your own code when debugging signals.

The Signal Debugger panel has two main components. The first is the signal tree. Similar to Signal Visualizer, all relevant scene signals are displayed in the tree.

![Signal Debugger Signal Tree Pane](./images/SignalDebuggerSignalTreeScreenshot.png)

The second main component is the signal log output. This is the main body of the Signal Debugger panel and contains all log messages for signals that have been triggered in the scene.

![Signal Debugger Signal Log Output Pane](./images/SignalDebuggerSignalLogScreenshot.png)

With your game scene running, navigate to the Signal Debugger panel under the Debugger dock item. Click the `Start` button to begin signal logging. With the Signal Debugger started, the scene's signal tree will appear and a started message will appear in the signal log output. All relavant signals will log the following:

* Timestamp
* Node that fired the signal
* Signal Name

![Signal Debugger Panel with Data](./images/SignalDebuggerDataScreenshot.png)

Clicking `Stop` will stop signal debugging, disconnecting from all relavant signals in the current game scene. Closing the current game scene will disconnect and stop debugging as well.

## Love SignalVisualizer?

If you like this plugin, please consider donating. 😁

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C0T61WG)

## Troubleshooting

If you encounter any of the following issues, please log a bug on the issues tab.

#### Godot Freezes & Crashes

In the event, Godot freezes and crashes when clicking "Generate Graph", please toggle "Arrange Nodes" **off** and try again.