@rbxts/toucan-debugger 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/out/index.d.ts +0 -5
- package/out/init.luau +0 -5
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @rbxts/toucan-debugger
|
|
2
|
+
|
|
3
|
+
A visual debugger plugin for [Toucan](https://github.com/OverlineJunior/toucan).
|
|
4
|
+
|
|
5
|
+
It is currently very early in development and cannot observe the server. It can however:
|
|
6
|
+
|
|
7
|
+
- List every entity-like along its id and type icon;
|
|
8
|
+
- Display `ChildOf` hierarchies;
|
|
9
|
+
- Measure system runtimes (they're under schedules).
|
|
10
|
+
|
|
11
|
+
<img src="assets/showcase.png" style="vertical-align: bottom;"/>
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install @rbxts/toucan-debugger
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
> [!IMPORTANT]
|
|
20
|
+
> The version of Toucan your game uses must be the same as the one this debugger plugin uses. This package currently targets `@rbxts/toucan` `0.6.0`.
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
Pass the plugin to your scheduler before calling `run()`. It must be used on the client.
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import toucanDebugger, { themes } from "@rbxts/toucan-debugger";
|
|
28
|
+
|
|
29
|
+
// Passing a theme is optional — defaults to black.
|
|
30
|
+
scheduler().usePlugin(toucanDebugger, themes.black).run();
|
|
31
|
+
```
|
package/out/index.d.ts
CHANGED
|
@@ -4,11 +4,6 @@ export { type Theme, themes } from './themes';
|
|
|
4
4
|
/**
|
|
5
5
|
* Spawns a visual debugger.
|
|
6
6
|
*
|
|
7
|
-
* It is currently very early in development and cannot observe the server.
|
|
8
|
-
* It can however...
|
|
9
|
-
* - List every entity-like along its id and type icon;
|
|
10
|
-
* - Measure system runtimes (they're under schedules).
|
|
11
|
-
*
|
|
12
7
|
* @remarks
|
|
13
8
|
* Throws if used on the server.
|
|
14
9
|
*
|
package/out/init.luau
CHANGED
|
@@ -19,11 +19,6 @@ end
|
|
|
19
19
|
*
|
|
20
20
|
* Spawns a visual debugger.
|
|
21
21
|
*
|
|
22
|
-
* It is currently very early in development and cannot observe the server.
|
|
23
|
-
* It can however...
|
|
24
|
-
* - List every entity-like along its id and type icon;
|
|
25
|
-
* - Measure system runtimes (they're under schedules).
|
|
26
|
-
*
|
|
27
22
|
* @remarks
|
|
28
23
|
* Throws if used on the server.
|
|
29
24
|
*
|