@princeofscale/bloxforge 2.20.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.
Files changed (49) hide show
  1. package/assets/Baseplate.rbxl +0 -0
  2. package/dist/index.js +19391 -0
  3. package/package.json +62 -0
  4. package/studio-plugin/INSTALLATION.md +161 -0
  5. package/studio-plugin/MCPInspectorPlugin.rbxmx +171699 -0
  6. package/studio-plugin/MCPPlugin.rbxmx +171699 -0
  7. package/studio-plugin/default.project.json +19 -0
  8. package/studio-plugin/dev.project.json +23 -0
  9. package/studio-plugin/include/LibMP.lua +156378 -0
  10. package/studio-plugin/inspector-icon.png +0 -0
  11. package/studio-plugin/package-lock.json +692 -0
  12. package/studio-plugin/package.json +19 -0
  13. package/studio-plugin/plugin.json +10 -0
  14. package/studio-plugin/src/modules/ClientBroker.ts +447 -0
  15. package/studio-plugin/src/modules/Communication.ts +697 -0
  16. package/studio-plugin/src/modules/EvalBridges.ts +255 -0
  17. package/studio-plugin/src/modules/HttpDiagnostics.ts +50 -0
  18. package/studio-plugin/src/modules/JobRegistry.ts +77 -0
  19. package/studio-plugin/src/modules/LuauExec.ts +465 -0
  20. package/studio-plugin/src/modules/Recording.ts +28 -0
  21. package/studio-plugin/src/modules/RenderMonitor.ts +60 -0
  22. package/studio-plugin/src/modules/RuntimeLogBuffer.ts +152 -0
  23. package/studio-plugin/src/modules/ServerUrlSettings.ts +114 -0
  24. package/studio-plugin/src/modules/State.ts +101 -0
  25. package/studio-plugin/src/modules/StopPlayMonitor.ts +276 -0
  26. package/studio-plugin/src/modules/UI.ts +790 -0
  27. package/studio-plugin/src/modules/Utils.ts +318 -0
  28. package/studio-plugin/src/modules/handlers/AssetHandlers.ts +241 -0
  29. package/studio-plugin/src/modules/handlers/BreakpointHandlers.ts +460 -0
  30. package/studio-plugin/src/modules/handlers/BuildHandlers.ts +481 -0
  31. package/studio-plugin/src/modules/handlers/CaptureHandlers.ts +203 -0
  32. package/studio-plugin/src/modules/handlers/EvalRuntimeHandlers.ts +149 -0
  33. package/studio-plugin/src/modules/handlers/InputHandlers.ts +160 -0
  34. package/studio-plugin/src/modules/handlers/InstanceHandlers.ts +380 -0
  35. package/studio-plugin/src/modules/handlers/JobHandlers.ts +111 -0
  36. package/studio-plugin/src/modules/handlers/LogHandlers.ts +14 -0
  37. package/studio-plugin/src/modules/handlers/MemoryHandlers.ts +44 -0
  38. package/studio-plugin/src/modules/handlers/MetadataHandlers.ts +354 -0
  39. package/studio-plugin/src/modules/handlers/MicroProfilerHandlers.ts +1263 -0
  40. package/studio-plugin/src/modules/handlers/PropertyHandlers.ts +191 -0
  41. package/studio-plugin/src/modules/handlers/QueryHandlers.ts +809 -0
  42. package/studio-plugin/src/modules/handlers/SceneAnalysisHandlers.ts +216 -0
  43. package/studio-plugin/src/modules/handlers/ScriptHandlers.ts +530 -0
  44. package/studio-plugin/src/modules/handlers/ScriptProfilerHandlers.ts +386 -0
  45. package/studio-plugin/src/modules/handlers/SerializationHandlers.ts +172 -0
  46. package/studio-plugin/src/modules/handlers/TestHandlers.ts +535 -0
  47. package/studio-plugin/src/server/index.server.ts +134 -0
  48. package/studio-plugin/src/types/index.d.ts +83 -0
  49. package/studio-plugin/tsconfig.json +21 -0
package/package.json ADDED
@@ -0,0 +1,62 @@
1
+ {
2
+ "name": "@princeofscale/bloxforge",
3
+ "version": "2.20.2",
4
+ "description": "Open-source AI agent toolkit for building, inspecting, testing, and automating Roblox games in Studio.",
5
+ "main": "dist/index.js",
6
+ "type": "module",
7
+ "bin": {
8
+ "bloxforge": "dist/index.js"
9
+ },
10
+ "files": [
11
+ "dist/**/*",
12
+ "studio-plugin/**/*",
13
+ "assets/**/*"
14
+ ],
15
+ "scripts": {
16
+ "build": "tsup",
17
+ "prepack": "node ../../scripts/prepack.mjs",
18
+ "postpack": "node ../../scripts/postpack.mjs"
19
+ },
20
+ "keywords": [
21
+ "mcp",
22
+ "mcp-server",
23
+ "roblox",
24
+ "roblox-studio",
25
+ "model-context-protocol",
26
+ "claude-code",
27
+ "codex",
28
+ "cursor",
29
+ "gemini",
30
+ "ai-agent",
31
+ "ai-coding",
32
+ "luau",
33
+ "roblox-plugin",
34
+ "game-development",
35
+ "automation",
36
+ "open-source",
37
+ "developer-tools"
38
+ ],
39
+ "author": "",
40
+ "license": "MIT",
41
+ "publishConfig": {
42
+ "access": "public"
43
+ },
44
+ "repository": {
45
+ "type": "git",
46
+ "url": "git+https://github.com/princeofscale/bloxforge.git"
47
+ },
48
+ "homepage": "https://github.com/princeofscale/bloxforge#readme",
49
+ "bugs": {
50
+ "url": "https://github.com/princeofscale/bloxforge/issues"
51
+ },
52
+ "dependencies": {
53
+ "@modelcontextprotocol/sdk": "^1.27.1",
54
+ "cors": "^2.8.5",
55
+ "express": "^4.22.2",
56
+ "node-fetch": "^3.3.2",
57
+ "ws": "^8.21.0"
58
+ },
59
+ "devDependencies": {
60
+ "@princeofscale/bloxforge-core": "*"
61
+ }
62
+ }
@@ -0,0 +1,161 @@
1
+ # BloxForge Plugin Installation Guide
2
+
3
+ Complete your AI assistant integration with this easy-to-install Studio plugin. Works with Claude Code, Claude Desktop, and any MCP-compatible AI.
4
+
5
+ ## Quick Installation
6
+
7
+ ### Method 1: Roblox Creator Store (Easiest)
8
+ 1. **Install from Creator Store:**
9
+ - Visit: https://create.roblox.com/store/asset/132985143757536
10
+ - Click **"Install"** button
11
+ - Plugin automatically opens in Studio
12
+
13
+ 2. **No restart needed** - Plugin appears immediately in toolbar!
14
+
15
+ ### Method 2: Direct Download
16
+ 1. **Download the plugin:**
17
+ - **GitHub Release**: [Download MCPPlugin.rbxmx](https://github.com/princeofscale/bloxforge/releases/latest/download/MCPPlugin.rbxmx)
18
+ - **CLI installer**: `npx -y @princeofscale/bloxforge@latest --install-plugin`
19
+ - This is the official Roblox plugin format
20
+
21
+ 2. **Install to plugins folder:**
22
+ - **Windows**: Save to `%LOCALAPPDATA%/Roblox/Plugins/`
23
+ - **macOS**: Save to `~/Documents/Roblox/Plugins/`
24
+ - **Or use Studio**: Plugins tab > Plugins Folder > drop the file
25
+ - Keep only one MCP variant in this folder. Remove `MCPInspectorPlugin.rbxmx` if installing `MCPPlugin.rbxmx`, and remove `MCPPlugin.rbxmx` if installing the inspector variant.
26
+
27
+ 3. **Restart Roblox Studio** - Plugin appears automatically!
28
+
29
+ ### Method 3: Save as Local Plugin
30
+ 1. **Copy the plugin code:**
31
+ - Open [studio-plugin/src/server/index.server.ts](https://github.com/princeofscale/bloxforge/blob/main/studio-plugin/src/server/index.server.ts) on GitHub (or build locally - see project README)
32
+ - Copy all the code (Ctrl+A, Ctrl+C)
33
+
34
+ 2. **Create in Studio:**
35
+ - Open Roblox Studio with any place
36
+ - Create a new Script in ServerScriptService
37
+ - Paste the plugin code
38
+ - **Right-click script** > **"Save as Local Plugin..."**
39
+ - Name it "BloxForge"
40
+
41
+ 3. **Plugin appears immediately** in your toolbar!
42
+
43
+ ## Setup & Configuration
44
+
45
+ ### 1. Enable HTTP Requests (Required)
46
+ **Game Settings** > **Security** > **"Allow HTTP Requests"**
47
+
48
+ ### 2. Activate the Plugin
49
+ **Plugins toolbar** > Click **"MCP Server"** button
50
+ - **Green status** = Connected and ready
51
+ - **Red status** = Disconnected (normal until MCP server runs)
52
+
53
+ ### 3. Install MCP Server
54
+ Choose your AI assistant:
55
+
56
+ **For Claude Code:**
57
+ ```bash
58
+ claude mcp add robloxstudio -- npx -y @princeofscale/bloxforge@latest --auto-install-plugin
59
+ ```
60
+
61
+ **For Codex CLI:**
62
+ ```bash
63
+ codex mcp add robloxstudio -- npx -y @princeofscale/bloxforge@latest --auto-install-plugin
64
+ ```
65
+
66
+ **For Claude Desktop/Others:**
67
+ ```json
68
+ {
69
+ "mcpServers": {
70
+ "bloxforge": {
71
+ "command": "npx",
72
+ "args": ["-y", "@princeofscale/bloxforge@latest", "--auto-install-plugin"]
73
+ }
74
+ }
75
+ }
76
+ ```
77
+
78
+ `@latest` floats the server package to the newest npm release. `--auto-install-plugin` copies the matching `.rbxmx` bundled with that package into Studio's Plugins folder when the server starts.
79
+
80
+ If Studio shows a yellow plugin/server version mismatch banner, the connection remains usable. Restart the MCP server with `--auto-install-plugin`, then fully close and reopen Studio so it loads the matching plugin file.
81
+
82
+ <details>
83
+ <summary>Note for native Windows users</summary>
84
+ If you encounter issues, you may need to run it through `cmd`. Update your configuration like this:
85
+
86
+ ```json
87
+ {
88
+ "mcpServers": {
89
+ "bloxforge": {
90
+ "command": "cmd",
91
+ "args": ["/c", "npx", "-y", "@princeofscale/bloxforge@latest", "--auto-install-plugin"]
92
+ }
93
+ }
94
+ }
95
+ ```
96
+ </details>
97
+
98
+ ## How It Works
99
+
100
+ 1. **AI calls tool** > MCP server queues request
101
+ 2. **Plugin polls** every 500ms for work
102
+ 3. **Plugin executes** Studio API calls
103
+ 4. **Plugin responds** with extracted data
104
+ 5. **AI receives** comprehensive Studio information
105
+
106
+ **Available Tools:** 37+ specialized tools for file trees, scripts, properties, attributes, tags, and more!
107
+
108
+ ## Troubleshooting
109
+
110
+ ### Plugin Missing from Toolbar
111
+ - Verify file saved to correct plugins folder
112
+ - Restart Roblox Studio completely
113
+ - Check Output window for error messages
114
+
115
+ ### "HTTP 403 Forbidden" Errors
116
+ - Enable "Allow HTTP Requests" in Game Settings > Security
117
+ - Verify MCP server is running (status should show connected)
118
+
119
+ ### Plugin Shows "Disconnected"
120
+ - **Normal behavior** when MCP server isn't running
121
+ - Click "MCP Server" button to activate
122
+ - Install MCP server using commands above
123
+
124
+ ### Connection Issues
125
+ - Check Windows Firewall isn't blocking localhost:58741
126
+ - Restart both Studio and your AI assistant
127
+ - Check Studio Output window for detailed error messages
128
+
129
+ ## Security & Privacy
130
+
131
+ - **Local-only**: All communication stays on your machine
132
+ - **No external servers**: Plugin only talks to localhost
133
+ - **Read-only access**: Plugin extracts data but never modifies your place
134
+ - **No data collection**: Your projects remain private
135
+
136
+ ## Advanced Usage
137
+
138
+ ### Plugin Features
139
+ - **Real-time status**: Visual connection indicators
140
+ - **Smart polling**: Exponential backoff for failed connections
141
+ - **Error recovery**: Automatic retry with timeout handling
142
+ - **Debug friendly**: Comprehensive logging in Output window
143
+
144
+ ### Customization
145
+ - **Server URL**: Modify in plugin UI (default: http://localhost:58741)
146
+ - **Poll interval**: 500ms default (editable in code)
147
+ - **Timeout settings**: 30-second request timeouts
148
+
149
+ ### Development Mode
150
+ ```lua
151
+ -- Enable debug logging in plugin code:
152
+ local DEBUG_MODE = true
153
+ ```
154
+
155
+ ## Pro Tips
156
+
157
+ - **Keep Studio open** while using AI assistants
158
+ - **Plugin auto-connects** when MCP server starts
159
+ - **Monitor status** via the dock widget
160
+ - **Use AI tools** to explore game architecture, find bugs, analyze dependencies
161
+ - **Perfect for** code reviews, debugging, and understanding complex projects!