Using Eclipse as a Maya IDE
This is an updated tutorial - December 2011.
I began using jEdit in 2001 until 2005 and it served me well during that time writing mel, C++ plugins and python for Maya. jEdit became my Maya IDE. But I then discovered Eclipse - and it outshines jEdit.
This tutorial will outline the steps I've taken to make Eclipse my Maya IDE. The Maya Editor plugin enables communication directly with Maya for both Python and mel. It also accesses various sets of documentation. Python programming for Maya has been enhanced by adding autocompletion for the Maya API and Pymel. If there are more features you think should be added, please contact me and I'll see what I can do.
A. Basic resources.
Pydev the open source python plugin for Eclipse
B. Maya Editor
This is a plugin for Eclipse that turns it into a Maya IDE. As it is Python-centric, it also requires the Pydev plugin.
Send the entire contents of an editor to Maya
Send a highlighted selection to Maya
Get results back from Maya in it's own console view
Anything done within Maya's own script editor is also echoed in the console view
Change the port number of the socket at any time
Open up documentation for Maya's Python API, Python Commands, Pymel, Qt, PySide, PyQt
1. Unzip the dowloaded file in a temp directory
2. In Eclipse, go to the Help/Install New Software page. Click on "Add" and then "Local" and navigate to the temp directory where the org.eclipse.eclipseMayaEditorProject is
3. In the "Name" section, make sure "Uncategorized" is selected and then click "Next"
4. Allow Eclipse to relaunch and once it's back, the EclipseMaya toolbar should be visible
5. In Maya, create a new shelf button with the following code or put it in the Startup script
import maya.cmds as cmds
if cmds.commandPort(':7720', q=True) !=1:
cmds.commandPort(n=':7720', eo = False, nr = True)
Ctrl+Return -> Send editor contents to Maya
Ctrl+' -> Send highlighted selection to Maya
Ctrl+] -> Reconnect Eclipse to Maya
Port Number - By default, the port number has been set to 7720. It can be changed at any time. Remember to press the "Reconnect Eclipse to Maya" button. This is handy if you have more than one instance of Maya open at once.
Update Interval: This sets how often Eclipse checks to see if there's any new text in Maya. It is in time units of seconds.
The next eight text fields set the location of the various sets of documentation. They can be entered either as web URLs or local file paths depending on where the docs are located. There are 2 user defined options for other documentation sites (If anyone needs more, let me know and I can add more).