@rbxts/toucan-debugger 1.0.3 → 1.0.4

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 CHANGED
@@ -1,31 +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
- ```
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.7.1`.
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
+ ```
@@ -1,3 +1,4 @@
1
- import type { Theme } from '.';
2
- declare const blackTheme: Theme;
3
- export default blackTheme;
1
+ import type { Theme } from '.'
2
+
3
+ declare const blackTheme: Theme
4
+ export default blackTheme
@@ -1,49 +1,49 @@
1
- export declare const ROBLOX_TOPBAR_HEIGHT = 58;
1
+ export declare const ROBLOX_TOPBAR_HEIGHT = 58
2
2
  export interface Theme {
3
- colors: {
4
- content: Color3;
5
- contentMuted: Color3;
6
- contentInverse: Color3;
7
- surface1: Color3;
8
- surface2: Color3;
9
- surface3: Color3;
10
- border: Color3;
11
- borderMuted: Color3;
12
- client: Color3;
13
- server: Color3;
14
- err: Color3;
15
- };
16
- icons: {
17
- chevronRight: string;
18
- chevronRightBold: string;
19
- chevronDown: string;
20
- chevronDownBold: string;
21
- entity: string;
22
- component: string;
23
- system: string;
24
- schedule: string;
25
- plugin: string;
26
- };
27
- fonts: {
28
- black: Font;
29
- bold: Font;
30
- regular: Font;
31
- extraLightItalic: Font;
32
- };
33
- fontSizes: {
34
- tiny: number;
35
- small: number;
36
- large: number;
37
- huge: number;
38
- };
39
- paddingSizes: {
40
- small: UDim;
41
- medium: UDim;
42
- large: UDim;
43
- };
44
- explorerIndent: number;
3
+ colors: {
4
+ content: Color3
5
+ contentMuted: Color3
6
+ contentInverse: Color3
7
+ surface1: Color3
8
+ surface2: Color3
9
+ surface3: Color3
10
+ border: Color3
11
+ borderMuted: Color3
12
+ client: Color3
13
+ server: Color3
14
+ err: Color3
15
+ }
16
+ icons: {
17
+ chevronRight: string
18
+ chevronRightBold: string
19
+ chevronDown: string
20
+ chevronDownBold: string
21
+ entity: string
22
+ component: string
23
+ system: string
24
+ schedule: string
25
+ plugin: string
26
+ }
27
+ fonts: {
28
+ black: Font
29
+ bold: Font
30
+ regular: Font
31
+ extraLightItalic: Font
32
+ }
33
+ fontSizes: {
34
+ tiny: number
35
+ small: number
36
+ large: number
37
+ huge: number
38
+ }
39
+ paddingSizes: {
40
+ small: UDim
41
+ medium: UDim
42
+ large: UDim
43
+ }
44
+ explorerIndent: number
45
45
  }
46
46
  export declare const themes: {
47
- black: Theme;
48
- white: Theme;
49
- };
47
+ black: Theme
48
+ white: Theme
49
+ }
@@ -1,3 +1,4 @@
1
- import type { Theme } from '.';
2
- declare const whiteTheme: Theme;
3
- export default whiteTheme;
1
+ import type { Theme } from '.'
2
+
3
+ declare const whiteTheme: Theme
4
+ export default whiteTheme
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/toucan-debugger",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "",
5
5
  "main": "out/init.lua",
6
6
  "scripts": {
@@ -35,6 +35,6 @@
35
35
  },
36
36
  "dependencies": {
37
37
  "@rbxts/services": "^1.6.0",
38
- "@rbxts/toucan": "0.7.0"
38
+ "@rbxts/toucan": "0.7.1"
39
39
  }
40
40
  }