How to use c4dpy for Cinema4D R20 SP1

dskeithbuck

Okay, I can't promise this is the correct way to do this, but it seems to have worked for me:

Install C4D Py

Ensure that you have Cinema 4D R20+ installed, I don't think this will work without it.
In your C4D install directory, unzip the sdk.zip file. (Note: this step might not be strictly necessary, not sure.)
Download the latest c4dpy[URL-REMOVED], ensure that it corresponds with your version of C4D.
- You may need to download the latest C4D Service Pack via the Online Updater (C4D > Help > Check for Updates...)
Unzip the c4dpy .zip file and copy the contents into your C4D install directory. C4dpy seems to rely on your C4D install's library files and will spit out errors if you don't do this.

Verify the Installation

Mac

Note: I haven't tested on mac, so I'm not sure this works.

Cmd + Space then Terminal
Drag the c4dpy.app file into the terminal - you should get the path to the file.

PC

Open terminal on Mac or Command Prompt on PC
Drag the c4dpy.exe file into the Command Prompt

Both

Press enter/return
You should see something like:

C:\Users\donovan>"C:\Program Files\MAXON\Cinema 4D R20\c4dpy.exe"
Welcome to the world of C4D and Python 2.7.14 (default, May  3 2018, 18:05:57) [MSC v.1500 64 bit (AMD64)] (c) 2018

Setup your IDE

Instructions will vary a bit on a per IDE basis.

Create a test script (All IDEs)

Open C4D
Script > Script Manager
Script Manager > File > New.... You should see something like:

import c4d
from c4d import gui
# Welcome to the world of Python


# Script state in the menu or the command palette
# Return True or c4d.CMD_ENABLED to enable, False or 0 to disable
# Alternatively return c4d.CMD_ENABLED|c4d.CMD_VALUE to enable and check/mark
#def state():
#    return True

# Main function
def main():
    gui.MessageDialog('Hello World!')

# Execute main()
if __name__=='__main__':
    main()

Script Manager > File > Save...
Save the script as helloworld.py.
Open your scripts folder: C4D > Script > User Scripts > Script Folder...
Open the helloworld.py in your IDE.

PyCharm

0_1536094384719_8cdcbe43-0e13-4d8c-9de7-98521145bbc0-image.png

Configure your Intepreter

Additional C4D Py Prep

PyCharm requires that Python Interpreters be named python.exe so rename the c4dpy.exe file in your C4D Directory to python.exe. (Note: I'm not sure if this breaks any of C4D Python's functionality).

In PyCharm

File > Settings > Project > Interpreter
Click on the Project Interpreter dropdown (probably says Python 2.7) and select "Show All".
Click on the + to add a new interpreter.
Click on System Interpreter
Browse to the location of the renamed c4dpy.exe (now called python.exe).
Choose OK. It will probably take a minute for the Interpreters list to update to include the c4dpy interpreter.
Choose OK to select the Python 2.7 (1) interpreter (Or however your renamed c4dpy.exe interpreter is listed).
In the text editor type from c4d import then hit ctrl + space trigger auto-complete.
- You may see a status update about "Updating skeletons" this can take a few minutes the first time as PyCharm has to build up a map of the C4D sdk (<- I think that's what it's doing, not certain).
Eventually, you should see something like:

Congratulations, you've now got AutoComplete working in PyCharm!

Microsoft VS Code

0_1536099876801_ed15bae1-6a61-4343-acf7-9074ec817b47-image.png

Prerequisites

If you can't get IntelliSense (autocomplete) working with a default Python install, it's probably not going to work with a C4D Py. If you can do the following, you're in good shape to work with C4D Py in VS Code.

Install the Python VS Code Extension
Follow the VS Code Python Tutorial.

Configure VS Code

Open VS Code
File > Open Folder > ... Navigate to your C4D Scripts folder (You can use C4D > Scripts > User Scripts > Scripts Folder... to easily find it).
Ctrl + Shift + P to search for : "workspace settings" (Note: this setting is only being adjusted for this folder).
In the worspace settings panel...
Start typing python.pythonPath then hit enter

{
    "python.pythonPath": "python"
}

Set the python path to the location of your c4dpy.exe file.

{
    "python.pythonPath": "C:\Program Files\MAXON\Cinema 4D R20\c4dpy.exe"
}

Windows paths use a \ which needs to be escaped \\ or reversed / for the path to properly register in the VSCode Settings.

{
    "python.pythonPath": "C:/Program Files/MAXON/Cinema 4D R20/c4dpy.exe"
}

File > Save Workspace (This will ensure the settings get remembered.
Restart VS Code
In helloworld.py in main(): type gui. and then press ctrl + space. You'll see:
Wait a minute as VS code builds up its understanding of C4D's API, eventually, you should see:

Congratulations, you've now got AutoComplete working in VS Code!

To the C4D Devs: If these instructions are accurate, and you haven't alread written something similar, feel free to include it in the SDK / C4D Py Docs.

-- Edits --

2018/09/05 10:27 - Added screenshot to clarify that you should copy the contents of the Unzipped file to your C4D directory.
2018/09/04 15:50 - Added instructions for VS Code.

[URL-REMOVED] @maxon: This section contained a non-resolving link which has been removed.

dskeithbuck

This post is deleted!

alfieB

You total legend.

Thank you so much for the time and care you took on this. I'll try it out now.

Alfie

alfieB

Worked like a charm. Thank you.

The only possible clarification I would add (because despite your fantastic directions, this still got me for a few mins) is that you need to take the contents OUT of the unzipped folder, so that the c4dpy.exe sits in the same folder as the actual cinema4d.exe.

I'm aware you did explain this.. its just been a slow morning.

Alfie

dskeithbuck

@alfieb Thanks for the heads up. Added a screenshot to clarify.

a_block

Thanks Donovan for your elaborate description.
I'll notify in this thread as soon as the section about c4dpy got added to the Python SDK docs.

One reminder:
Please help us to keep this place tidy and make use of the available tags, when posting. For this thread I already added some.

GiuseppeLecis

Hello everyone,
Someone have tested this workflow on mac? I'm trying to do it on a mac but i can't setup the IDE. Probably the problem is my lack in terminal shell usage but i don't know if possible to execute a .exe file via shell on a mac system. When i drag the c4dpy.app file into the shell and after pressed enter i don't see this "Welcome to the world of C4D and Python 2.7.14 (default, May 3 2018, 18:05:57) [MSC v.1500 64 bit (AMD64)] (c) 2018" but this " -bash: /Applications/MAXON/Cinema 4D R20/c4dpy.app: is a directory". If i drag the c4dpy.exe the result is: -bash: /Applications/MAXON/Cinema 4D R20/c4dpy.exe: cannot execute binary file
Going on i can't set up the environment properly. Someone could help me please? thanks in advance

G.L.

alfieB

Hi Giuseppe,
After the instruction from dskeithbuck, i set up on both windows and mac. With mac its a little different due the way the os packages things. You are getting the error message because the .app is indeed a directory. Open it by right click -> Show package contents -> Contents -> MacOS and in there is the executable you need.

Hope this helps.

Alfie

GiuseppeLecis

@alfieb Thank you so much for your kindly reply! I have solved thanks to your suggestion :-)!

a_block

Hello,

we have updated the Python SDK documentation including c4dpy instructions.
Let us know, if you are missing something in there.

Cheers,
Andreas

tychris

I haven't been able to get c4dpy.exe to run without throwing an 0xC5 access violation error. I have the latest .exe downloaded and placed next to all the other C4D R20 executables, and my R20 instance is running R20.028. Does c4dpy.exe need to be updated for R20.028? I see lots of "UNKNOWNBUILDID" messages in stdout.

a_block

Hi,

I'm terribly sorry for the inconvenience caused. You are right c4dpy needs to be updated for the latest hotfix (Cinema 4D R20 SP1, 20.028). Unfortunately due to our travels I had failed to upload the file. Sorry!
The updated version is now available on our blog's download page[URL-REMOVED].

Bye,
Andreas

[URL-REMOVED] @maxon: This section contained a non-resolving link which has been removed.

tychris

Cool! Thanks very much. That's working for me now.

mikeudin

@a_block could you update the link to latest version of c4dpy here?
https://developers.maxon.net/docs/py/2023_2/misc/c4dpy.html

a_block

@mikeudin Thanks for making us aware. We'll change the link with the next docs update.