mirror of
https://github.com/tiennm99/MTTools.git
synced 2026-09-02 12:18:55 +00:00
docs(readme): add sample output and Godot bad-address-index context
This commit is contained in:
@@ -8,6 +8,24 @@ Detects cyclic dependencies in Godot projects that cause "bad address index" err
|
||||
python circular_dependency_checker.py <path-to-godot-project>
|
||||
```
|
||||
|
||||
## Why this exists
|
||||
|
||||
In GDScript, `preload()` calls at the top of a script are resolved at parse time. If script A preloads script B and B preloads A (directly or transitively), Godot raises a cryptic **"bad address index"** error at runtime — not a clear circular-import message. This tool walks all `.gd` files, builds a directed dependency graph from `class_name`, `extends`, and type annotations, then reports any cycles before you hit that error in the engine.
|
||||
|
||||
## Sample output
|
||||
|
||||
```
|
||||
Checking /path/to/my-godot-project...
|
||||
Cycle detected: PlayerState -> StateMachine -> PlayerState
|
||||
Cycle detected: Enemy -> EnemyAI -> BaseAI -> Enemy
|
||||
2 cycle(s) found. Fix preload order or use load() with lazy initialization.
|
||||
```
|
||||
|
||||
If no cycles are found:
|
||||
```
|
||||
No circular dependencies detected.
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0 — see [LICENSE](LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user