Skip to content

Commit b2d5fea

Browse files
author
edowney
committed
Updated README.md for new functionality and added Troubleshooting section for known bugs and suggestions.
1 parent 202b9df commit b2d5fea

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ A plugin for Godot 4.x. SignalVisualizer displays the current scene's signals an
77

88
The SignalVisualizer plugin can be installed from source.
99

10+
### Godot Asset Library Installation
11+
12+
1. In Godot's AssetLib tab, search for SignalVisualizer
13+
1. Download & Install
14+
15+
[Godot Asset Library: SignalVisualizer](https://godotengine.org/asset-library/asset/2067)
16+
1017
### Installation via Github
1118

1219
1. Download the repo
@@ -32,6 +39,18 @@ Signal Visualizer will create a signal graph by mapping the signals in the curre
3239

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

42+
### Arrange Nodes Toggle
43+
44+
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.
45+
46+
### Signal Details Toggle
47+
48+
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.
49+
50+
### Opening Signals in Source
51+
52+
The "Open" button that displays next to a signal's connected function will open the corresponding source file at the function's line number.
53+
3554
### Format
3655

3756
In the signal graph and tree, the format is as follows:
@@ -51,3 +70,11 @@ Signal::Callable Method
5170
```
5271

5372
![GameUI Node Incoming Signals](./images/IncomingSignalScreenshot.png)
73+
74+
### Troubleshooting
75+
76+
If you encounter any of the following issues, please log a bug on the issues tab.
77+
78+
#### Godot Freezes & Crashes
79+
80+
In the event, Godot freezes and crashes when clicking "Generate Graph", please toggle "Arrange Nodes" **off** and try again.

0 commit comments

Comments
 (0)