SignalVisualizer - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #llm #golang #android #rust #linux #docker #awesome #kubernetes #awesome-list #open-source

SignalVisualizer

(★ 680)

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

File Explorer

Download Latest Version (.zip)

- - bug_report.md
- FUNDING.yml
- - Clear.svg
  - Clear.svg.import
  - GraphEdit.svg
  - GraphEdit.svg.import
  - Play.svg
  - Play.svg.import
  - plugin.cfg
  - SignalVisualizer.gd
  - Stop.svg
  - Stop.svg.import
- CharacterBody2D.gd
- Demo1.gd
- Demo1.tscn
- Demo2.gd
- Demo2.tscn
- Demo3.gd
- Demo3.tscn
- .gdignore
- AutoloadScreenshot.png
- IncomingSignalScreenshot.png
- OutgoingSignalScreenshot .png
- PluginScreenshot.png
- SignalDebuggerDataScreenshot.png
- SignalDebuggerPanel.png
- SignalDebuggerSignalLogScreenshot.png
- SignalDebuggerSignalTreeScreenshot.png
- SignalVisualizerBanner.png
- SignalVisualizerDemo.png
- SignalVisualizerDockScreenshot.png
- SignalVisualizerGraphDemo.png
- SignalVisualizerIcon.png
- SignalVisualizerToolbarScreenshot.png
.gitattributes
.gitignore
icon.svg
icon.svg.import
LICENSE
project.godot
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    <img width="400" src="./images/SignalVisualizerBanner.png" alt="Signal Visualizer Plugin Banner" />
</p>

<center>

[![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 and autoload signal connections in an easy to read graph and tree dock.

</center>

![Signal Visualizer plugin running Godot 4.x](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/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](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/images/PluginScreenshot.png)

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

![Godot 4.x bottom dock displaying Signal Visualizer tab](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/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](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/images/SignalDebuggerPanel.png)

## Usage

<details>
<summary><h3>Signal Visualizer</h3></summary>

Signal Visualizer will create a signal graph by mapping the persisted signal connections in the current scene and project autoloads 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.](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/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.

#### 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](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/images/OutgoingSignalScreenshot%20.png)

##### Incoming Signal

```
Signal::Callable Method
```

![GameUI Node Incoming Signals](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/images/IncomingSignalScreenshot.png)
</details>

<details>
<summary><h3>Signal Debugger</h3></summary>

The Signal Debugger connects to a running scene instance to allow for automatic logging of live signal executions. This includes signals connected through code at runtime and 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 and autoload signals are displayed in the tree.

![Signal Debugger Signal Tree Pane](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/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](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/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 relevant signals will log the following:

* Timestamp
* Node that fired the signal
* Signal Name

![Signal Debugger Panel with Data](https://raw.githubusercontent.com/Ericdowney/SignalVisualizer/main/images/SignalDebuggerDataScreenshot.png)

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

</details>

## 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.