https://github.com/blurstudio/sublime_debugger-mayaui

An adapter for debugging custom UI in Maya using Sublime Debugger in Sublime Text 3 and 4
https://github.com/blurstudio/sublime_debugger-mayaui

debug-adapter-protocol debugger maya python sublime-text-3 sublime-text-4

Last synced: 27 days ago
JSON representation

An adapter for debugging custom UI in Maya using Sublime Debugger in Sublime Text 3 and 4

• Host: GitHub
• URL: https://github.com/blurstudio/sublime_debugger-mayaui
• Owner: blurstudio
• License: mit
• Created: 2021-04-06T21:49:28.000Z (about 5 years ago)
• Default Branch: st3
• Last Pushed: 2021-06-29T21:17:22.000Z (almost 5 years ago)
• Last Synced: 2025-03-20T19:12:03.533Z (about 1 year ago)
• Topics: debug-adapter-protocol, debugger, maya, python, sublime-text-3, sublime-text-4
• Language: Python
• Homepage:
• Size: 10.7 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# A Debug Adapter for Debugging functions called by Custom Maya UI Components

This adapter serves as a "middleman" between the Sublime Debugger plugin 

and a DAP implementation for python (debugpy) injected into Maya.

It intercepts a few DAP requests to establish a connection between the debugger and Maya, and 

otherwise forwards all communications between the debugger and debugpy normally.

## Installation

To install from repo,

- Open Sublime

- Install the "Debugger" plugin with Package Control if not done already

- In the "Preferences" menu, select "Browse Packages..."

- Clone this repository into the folder opened by Sublime

- Open the project you want to debug

    - If the debugger isn't open, select "Open" in the "Debugger" menu option

    - If it still doesn't open, ensure your project settings (Project -> Edit Project) are not empty, then try again

- Under the "Debugger" menu, select "Add or Select Configuration"

- Select "Add Configuration" from the suggestions

- There should be a "Maya: Custom UI Debugging" option, click on it

- You should have your project settings automatically opened, edited with the configuration

- Save your project settings

## Use

- Go to Debugger -> Add or Select Configuration, and select "Maya: Custom UI Debugging"

- Place breakpoints wherever needed

- Press play -- Nothing will seem to happen other than the pause button lighting 

- In Maya, click on the relevant UI components to start debugging them

The Maya UI Adapter should now be functional just by pressing play.

If it is your first time installing the adapter and Maya is already open, make sure to restart Maya first (a first-time setup is performed).

## Note

Currently only tested on Windows