Skip to content

Commit 8e37ff3

Browse files
committed
Documentation Improvements
- Added Image Example - Confirmed ptvsd version 3.0.0 is needed. - Changed links.
1 parent 18b94da commit 8e37ff3

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

Example.png

286 KB
Loading

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Blender Debugger for VS Code
22

3-
Inspired by [Blender-VScode-Debugger](/Barbarbarbarian/Blender-VScode-Debugger) which was itself inspired by this [remote_debugger](/sybrenstuvel/random-blender-addons/blob/master/remote_debugger.py) for pycharm as explained in this [Blender Developer's Blog post](https://code.blender.org/2015/10/debugging-python-code-with-pycharm/).
3+
Inspired by [Blender-VScode-Debugger](https://github.com/Barbarbarbarian/Blender-VScode-Debugger) which was itself inspired by this [remote_debugger](https://github.com/sybrenstuvel/random-blender-addons/blob/master/remote_debugger.py) for pycharm as explained in this [Blender Developer's Blog post](https://code.blender.org/2015/10/debugging-python-code-with-pycharm/).
44

55

66
Since the VS Code one wasn't really well documented and it looked kind of dead, once I figured it out, I was just going to add the documentation, but then I ended up rewriting the whole thing.
@@ -10,6 +10,8 @@ Now it can:
1010
- Auto-detect where python is and auto set the path to ptvsd if installed.
1111
- Tell you when the debugger has actually attached.
1212

13+
![Image Showing VS Code side by side with Blender paused at a breakpoint. In the console, a "Debugger is Attached" Statement is printed.](./Example.png)
14+
1315
# How to Use
1416

1517
I'm in the process of writing a more detailed blog post for those who just started messing with python in Blender or programming in general, but if you're semi-familiar with Python, VS Code, and the command line the following should make sense. If you have any questions or suggestions, don't hesitate to file an issue.
@@ -20,7 +22,7 @@ Install Python 3 with pip and check add to PATH.
2022
- If you already have python installed and you can run it from the command line (aka PATH is set), the addon should find it. It uses `where python` or `whereis python` or `which python` depending on the OS to determine where python is. I only have windows at the moment, so only that is tested, but it should work.
2123

2224
`pip install ptvsd==3.0.0"
23-
- 3.0 because that was what was recommended in the VS Code documentation.
25+
- Newer versions do not work, you will just get an error in VS Code trying to connect. later versions aren't supported yet see [Debugging Python with VS Code](https://code.visualstudio.com/docs/python/debugging#_remote-debugging) and [#514](/Microsoft/vscode-python/issues/514).
2426

2527
## Setting up your Addon
2628

@@ -73,7 +75,7 @@ Go to the Debugging tab and add a configuration. Pick Python. You'll want the co
7375
},
7476
```
7577

76-
Now when you run the debugger with this config in Blender the console should print "Debugger is Attached" if it was still waiting (it should still attach even if it wasn't, it just won't tell you).
78+
Now when you run the debugger with this config in Blender and VS Code the console should print "Debugger is Attached" if it was still waiting (it should still attach even if it wasn't, it just won't tell you).
7779

7880
## How to Use
7981

@@ -93,9 +95,4 @@ Now in Blender the text editor will show this little red button in the top left.
9395

9496
# Notes
9597

96-
The addon also detects python if PYTHONPATH is set (because Blender will add it to sys.path) or if you used the Python bundled with Blender to install ptvsd (but that's a bit of a pain because it doesn't have pip installed unless you want to install it manually)
97-
98-
99-
100-
101-
98+
The addon also detects python if PYTHONPATH is set (because Blender will add it to sys.path) or if you used the Python bundled with Blender to install ptvsd (but that's a bit of a pain because it doesn't have pip installed unless you want to install it manually).

0 commit comments

Comments
 (0)