Skip to content

Commit 8db3af2

Browse files
committed
Improved Troubleshooting Documentation
- Added troubleshooting steps. - Added issue template. - Also added links regarding Visual Studio.
1 parent f205a41 commit 8db3af2

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

ISSUE_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!-- If filing a bug report please follow the troubleshooting steps in the README. If none of those helped please fill out the following: -->
2+
3+
OS:
4+
5+
VS Code Version:
6+
7+
VS Code Python Extension Version:
8+
9+
<!-- ...or Visual Studio Version: -->
10+
11+
PTVSD Version:
12+
13+
Paths listed by `where python` or the corresponding command:
14+
15+
Does VS Code / Visual Studio connect to the troubleshooting script?
16+
17+
Python path/interpreter detected/selected by VS Code / Visual Studio: <!-- See Connecting VS Code in the README -->
18+
19+
## Notes:
20+
21+
<!-- Describe your problem, including any specific errors. -->

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Blender Debugger for VS Code
1+
# Blender Debugger for VS Code (and Visual Studio)
22

33
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

@@ -67,9 +67,9 @@ Click `Debug: Start Debug Server for VS Code`. Note: you can only start the serv
6767

6868
Open your addon folder (e.g. "C:\Code\Blender Stuff\addons\myaddon").
6969

70-
Install the Python extension for VS Code if you haven't already.
70+
Install the Python extension for VS Code if you haven't already. For Visual Studio see [Installing Python Support](https://docs.microsoft.com/en-us/visualstudio/python/installing-python-support-in-visual-studio).
7171

72-
In the lower left ([see #3 here](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites)), VS Code should have auto detected your Python install and set it as the interpreter.
72+
In the lower left ([see #3 here](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites)), VS Code should have auto detected your Python install and set it as the interpreter. For Visual Studio see [Managing Python Environments](https://docs.microsoft.com/en-us/visualstudio/python/managing-python-environments-in-visual-studio).
7373

7474
Go to the Debugging tab and add a configuration. Pick Python. You'll want the configuration that looks like this, no need to change the defaults, you can delete the rest.
7575

@@ -104,6 +104,13 @@ Open the file in VS Code, connect to the debugging server, make a change and sav
104104

105105
Now in Blender the text editor will show this little red button in the top left. Click that and reload the file. Then in `Text Editor > Properties` turn on `Live Edit` if you haven't already. Now to actually get Blender to detect any changes you made just type a single character (like add a space anywhere) and *then* it will detect your changes.
106106

107+
# Troubleshooting
108+
109+
- Check you installed the correct ptvsd version.
110+
- To determine whether the problem is on Blender's side or your editor's: Close Blender and download/copy this [test script](https://gist.github.com/AlansCodeLog/ff1b246a8e31938e1c3dbfdcbb90522f) and run it with Python then and try to connect to the server with your editor. If you're still getting problem's than the problem is with VS Code.
111+
- Check your detected your Python install, or set it manually.
112+
- For VS Code try reinstalling the VS Code Python extension.
113+
107114
# Notes
108115

109116
<a id="f1" href="#n1">1.</a> Technically, the add-on will work with Python 2 as well since it doesn't use Python itself, just the ptvsd package, so it doesn't really matter whether you installed it with Python 2 or 3 because the package is compatible with both. On the VS Code side though, the Python extension does need to know where Python is (though not ptvsd), but it still will connect if it's using Python 2, just IntelliSense recommendations the will be wrong.

0 commit comments

Comments
 (0)