2025-05-25 09:14:52 +00:00
<!DOCTYPE html>
2025-08-15 16:53:30 +00:00
< html lang = "en" data-content_root = "../" >
2025-05-25 09:14:52 +00:00
< head >
< meta charset = "utf-8" / >
2025-08-15 16:53:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2025-05-25 09:14:52 +00:00
< title > DebugPy VSCode debugger integration — Evennia latest documentation< / title >
2025-08-15 16:53:30 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css?v=d75fae25" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/nature.css?v=279e0f84" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/custom.css?v=e4a91a55" / >
< script src = "../_static/documentation_options.js?v=c6e86fd7" > < / script >
< script src = "../_static/doctools.js?v=9bcbadda" > < / script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" > < / script >
< link rel = "icon" href = "../_static/favicon.ico" / >
2025-05-25 09:14:52 +00:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Easy fillable form" href = "Contrib-Fieldfill.html" / >
< link rel = "prev" title = "Input/Output Auditing" href = "Contrib-Auditing.html" / >
< / head > < body >
2025-08-15 16:53:30 +00:00
< div class = "related" role = "navigation" aria-label = "Related" >
2025-05-25 09:14:52 +00:00
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Fieldfill.html" title = "Easy fillable form"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Auditing.html" title = "Input/Output Auditing"
accesskey="P">previous< / a > |< / li >
2025-08-15 16:53:30 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia< / a > » < / li >
2025-05-25 09:14:52 +00:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" accesskey = "U" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > DebugPy VSCode debugger integration< / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "debugpy-vscode-debugger-integration" >
2025-08-15 16:53:30 +00:00
< h1 > DebugPy VSCode debugger integration< a class = "headerlink" href = "#debugpy-vscode-debugger-integration" title = "Link to this heading" > ¶< / a > < / h1 >
2025-05-25 09:14:52 +00:00
< p > Contribution by electroglyph, 2025< / p >
< p > This registers an in-game command < code class = "docutils literal notranslate" > < span class = "pre" > debugpy< / span > < / code > which starts the debugpy debugger and listens on port 5678.
For now this is only available for Visual Studio Code (VS Code).< / p >
< p > If you are a JetBrains PyCharm user and would like to use this, make some noise at:
< a class = "reference external" href = "https://youtrack.jetbrains.com/issue/PY-63403/Support-debugpy" > https://youtrack.jetbrains.com/issue/PY-63403/Support-debugpy< / a > < / p >
< p > Credit for this goes to Moony on the Evennia Discord getting-help channel, thx Moony!< / p >
< section id = "installation" >
2025-08-15 16:53:30 +00:00
< h2 > Installation< a class = "headerlink" href = "#installation" title = "Link to this heading" > ¶< / a > < / h2 >
2025-05-25 09:14:52 +00:00
< p > This requires VS Code and debugpy, so make sure you’ < / p >
< p > From the venv where you installed Evennia run:< / p >
< p > < code class = "docutils literal notranslate" > < span class = "pre" > pip< / span > < span class = "pre" > install< / span > < span class = "pre" > debugpy< / span > < / code > < / p >
< section id = "enable-the-command-in-evennia" >
2025-08-15 16:53:30 +00:00
< h3 > Enable the command in Evennia< a class = "headerlink" href = "#enable-the-command-in-evennia" title = "Link to this heading" > ¶< / a > < / h3 >
2025-05-25 09:14:52 +00:00
< p > In your Evennia mygame folder, open up < code class = "docutils literal notranslate" > < span class = "pre" > /commands/default_cmdsets.py< / span > < / code > < / p >
< p > add < code class = "docutils literal notranslate" > < span class = "pre" > from< / span > < span class = "pre" > evennia.contrib.utils.debugpy< / span > < span class = "pre" > import< / span > < span class = "pre" > CmdDebugPy< / span > < / code > somewhere near the top.< / p >
< p > in < code class = "docutils literal notranslate" > < span class = "pre" > CharacterCmdSet.at_cmdset_creation< / span > < / code > add this under < code class = "docutils literal notranslate" > < span class = "pre" > super().at_cmdset_creation()< / span > < / code > :< / p >
< p > < code class = "docutils literal notranslate" > < span class = "pre" > self.add(CmdDebugPy)< / span > < / code > < / p >
< / section >
< section id = "add-remote-attach-option-to-vs-code-debugger" >
2025-08-15 16:53:30 +00:00
< h3 > Add “remote attach” option to VS Code debugger< a class = "headerlink" href = "#add-remote-attach-option-to-vs-code-debugger" title = "Link to this heading" > ¶< / a > < / h3 >
2025-05-25 09:14:52 +00:00
< p > Start VS Code and open your launch.json like this:< / p >
2025-08-15 16:53:30 +00:00
< p > < img alt = "screenshot" src = "Contribs/vscode.png" / > < / p >
2025-05-25 09:14:52 +00:00
< p > Add this to your configuration:< / p >
< div class = "highlight-json notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Python Debugger: Remote Attach" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " justMyCode" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " debugpy" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " request" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " attach" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " connect" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " host" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 127.0.0.1" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " port" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 5678< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " pathMappings" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " localRoot" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ${workspaceFolder}" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " remoteRoot" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ${workspaceFolder}" < / span >
< span class = "w" > < / span > < span class = "p" > }< / span >
< span class = "w" > < / span > < span class = "p" > ]< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< / pre > < / div >
< / div >
< p > Use < code class = "docutils literal notranslate" > < span class = "pre" > 127.0.0.1< / span > < / code > for the host if you are running Evennia from the same machine you’ < / p >
< p > Afterwards it should look something like this:< / p >
< div class = "highlight-json notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "c1" > // Use IntelliSense to learn about possible attributes.< / span >
< span class = "w" > < / span > < span class = "c1" > // Hover to view descriptions of existing attributes.< / span >
< span class = "w" > < / span > < span class = "c1" > // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387< / span >
< span class = "w" > < / span > < span class = "nt" > " version" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 0.2.0" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " configurations" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Python Debugger: Current File" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " debugpy" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " request" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " launch" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " program" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ${file}" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " console" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " integratedTerminal" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " name" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Python Debugger: Remote Attach" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " justMyCode" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " debugpy" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " request" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " attach" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " connect" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " host" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 127.0.0.1" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " port" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 5678< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " pathMappings" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " localRoot" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ${workspaceFolder}" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " remoteRoot" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " ${workspaceFolder}" < / span >
< span class = "w" > < / span > < span class = "p" > }< / span >
< span class = "w" > < / span > < span class = "p" > ]< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > ]< / span >
< span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > (notice the comma between the curly braces)< / p >
< / section >
< / section >
< section id = "usage" >
2025-08-15 16:53:30 +00:00
< h2 > Usage< a class = "headerlink" href = "#usage" title = "Link to this heading" > ¶< / a > < / h2 >
2025-05-25 09:14:52 +00:00
< p > Set a breakpoint in VS Code where you want the debugger to stop at.< / p >
< p > In Evennia run < code class = "docutils literal notranslate" > < span class = "pre" > debugpy< / span > < / code > command.< / p >
< p > You should see “Waiting for debugger attach…”< / p >
< p > Back in VS Code attach the debugger:< / p >
2025-08-15 16:53:30 +00:00
< p > < img alt = "screenshot" src = "Contribs/attach.png" / > < / p >
2025-05-25 09:14:52 +00:00
< p > Back in Evennia you should see “Debugger attached.”< / p >
< p > Now trigger the breakpoint you set and you’ < / p >
< hr class = "docutils" / >
< p > < small > This document page is generated from < code class = "docutils literal notranslate" > < span class = "pre" > evennia/contrib/utils/debugpy/README.md< / span > < / code > . Changes to this
file will be overwritten, so edit that file rather than this one.< / small > < / p >
< / section >
< / section >
2025-08-15 16:53:30 +00:00
< div class = "clearer" > < / div >
2025-05-25 09:14:52 +00:00
< / div >
< / div >
< / div >
2025-08-15 16:53:30 +00:00
< div class = "sphinxsidebar" role = "navigation" aria-label = "Main" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo of Evennia" / >
< / a > < / p >
< search id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / search >
< script > document . getElementById ( 'searchbox' ) . style . display = "block" < / script >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > DebugPy VSCode debugger integration< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < ul >
< li > < a class = "reference internal" href = "#enable-the-command-in-evennia" > Enable the command in Evennia< / a > < / li >
< li > < a class = "reference internal" href = "#add-remote-attach-option-to-vs-code-debugger" > Add “remote attach” option to VS Code debugger< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#usage" > Usage< / a > < / li >
< / ul >
< / li >
< / ul >
< div >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Contrib-Auditing.html"
title="previous chapter">Input/Output Auditing< / a > < / p >
< / div >
< div >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Fieldfill.html"
title="next chapter">Easy fillable form< / a > < / p >
< / div >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Contribs/Contrib-Debugpy.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
< li > < a href = "https://www.evennia.com/docs/latest/index.html" > Documentation Top< / a > < / li >
< li > < a href = "https://www.evennia.com" > Evennia Home< / a > < / li >
< li > < a href = "https://github.com/evennia/evennia" > Github< / a > < / li >
< li > < a href = "http://games.evennia.com" > Game Index< / a > < / li >
< li >
< a href = "https://discord.gg/AJJpcRUhtF" > Discord< / a > -
< a href = "https://github.com/evennia/evennia/discussions" > Discussions< / a > -
< a href = "https://evennia.blogspot.com/" > Blog< / a >
< / li >
< / ul >
< h3 > Doc Versions< / h3 >
< ul >
< li >
< a href = "https://www.evennia.com/docs/latest/index.html" > latest (main branch)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/5.x/index.html" > v5.0.0 branch (outdated)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/4.x/index.html" > v4.0.0 branch (outdated)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/3.x/index.html" > v3.0.0 branch (outdated)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/2.x/index.html" > v2.0.0 branch (outdated)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/1.x/index.html" > v1.0.0 branch (outdated)< / a >
< / li >
< li >
< a href = "https://www.evennia.com/docs/0.x/index.html" > v0.9.5 branch (outdated)< / a >
< / li >
< / ul >
2025-05-25 09:14:52 +00:00
2025-08-15 16:53:30 +00:00
< / div >
< / div >
< div class = "clearer" > < / div >
2025-05-25 09:14:52 +00:00
< / div >
2025-08-15 16:53:30 +00:00
< div class = "related" role = "navigation" aria-label = "Related" >
2025-05-25 09:14:52 +00:00
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
>index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Fieldfill.html" title = "Easy fillable form"
>next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Auditing.html" title = "Input/Output Auditing"
>previous< / a > |< / li >
2025-08-15 16:53:30 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia< / a > » < / li >
2025-05-25 09:14:52 +00:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > DebugPy VSCode debugger integration< / a > < / li >
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
2025-08-15 16:53:30 +00:00
© Copyright 2024, The Evennia developer community.
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 8.2.3.
2025-05-25 09:14:52 +00:00
< / div >
< / body >
< / html >
