2022-11-14 22:43:45 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.17.1: http://docutils.sourceforge.net/" / >
2023-06-10 07:57:46 +00:00
< title > Coding and development help — Evennia 2.x documentation< / title >
2022-11-14 22:43:45 +01:00
< link rel = "stylesheet" href = "../_static/nature.css" type = "text/css" / >
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/language_data.js" > < / script >
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
2022-11-25 20:28:54 +00:00
< link rel = "next" title = "Evennia Code Style" href = "Evennia-Code-Style.html" / >
2022-11-26 14:42:25 +00:00
< link rel = "prev" title = "Zones" href = "../Concepts/Zones.html" / >
2022-11-14 22:43:45 +01:00
< / head > < body >
2023-06-10 07:57:46 +00:00
2023-06-10 08:53:19 +00:00
2023-06-10 07:57:46 +00:00
2022-11-14 22:43:45 +01:00
< div class = "related" role = "navigation" aria-label = "related navigation" >
< 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" >
2022-11-25 20:28:54 +00:00
< a href = "Evennia-Code-Style.html" title = "Evennia Code Style"
2022-11-14 22:43:45 +01:00
accesskey="N">next< / a > |< / li >
< li class = "right" >
2022-11-26 14:42:25 +00:00
< a href = "../Concepts/Zones.html" title = "Zones"
2022-11-14 22:43:45 +01:00
accesskey="P">previous< / a > |< / li >
2023-06-10 07:57:46 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > Coding and development help< / a > < / li >
< / ul >
2023-06-10 08:53:19 +00:00
< / div >
2022-11-14 22:43:45 +01:00
< div class = "document" >
< div class = "documentwrapper" >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
< / a > < / p >
< div 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" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Coding and development help< / a > < ul >
2022-12-01 21:58:35 +00:00
< li > < a class = "reference internal" href = "#evennia-changelog" > Evennia Changelog< / a > < ul >
< / ul >
< / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
2022-11-26 14:42:25 +00:00
< p class = "topless" > < a href = "../Concepts/Zones.html"
title="previous chapter">Zones< / a > < / p >
2022-11-14 22:43:45 +01:00
< h4 > Next topic< / h4 >
2022-11-25 20:28:54 +00:00
< p class = "topless" > < a href = "Evennia-Code-Style.html"
title="next chapter">Evennia Code Style< / a > < / p >
2022-11-14 22:43:45 +01:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Coding/Coding-Overview.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
2023-02-25 16:50:58 +00:00
< 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 >
2022-11-14 22:43:45 +01:00
< 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 >
2023-06-10 07:57:46 +00:00
< h3 > Doc Versions< / h3 >
2022-11-14 22:43:45 +01:00
< ul >
2023-06-10 07:57:46 +00:00
< li > < a href = "Coding-Overview.html" > 2.x (main branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
2023-06-10 08:12:58 +00:00
< li > < a href = "../1.3.0/index.html" > 1.3.0 (v1.3.0 branch)< / a > < / li >
2023-06-10 07:57:46 +00:00
2023-06-10 08:12:58 +00:00
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2023-06-10 07:57:46 +00:00
2022-11-15 20:29:38 +00:00
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "coding-and-development-help" >
< h1 > Coding and development help< a class = "headerlink" href = "#coding-and-development-help" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This documentation aims to help you set up a sane development environment to
2022-11-25 20:28:54 +00:00
make your game, also if you never coded before.< / p >
2022-11-23 20:20:36 +00:00
< p > See also the < a class = "reference internal" href = "../Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html" > < span class = "doc std std-doc" > Beginner Tutorial< / span > < / a > .< / p >
2022-11-14 22:43:45 +01:00
< div class = "toctree-wrapper compound" >
< ul >
2022-11-25 20:28:54 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Evennia-Code-Style.html" > Evennia Code Style< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Evennia-Code-Style.html#main-code-style-specification" > Main code style specification< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Evennia-Code-Style.html#code-docstrings" > Code Docstrings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Evennia-Code-Style.html#default-command-docstrings" > Default Command Docstrings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Evennia-Code-Style.html#tools-for-auto-linting" > Tools for auto-linting< / a > < / li >
< / ul >
< / li >
2022-11-26 14:42:25 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Default-Command-Syntax.html" > Default Command Syntax< / a > < / li >
2022-11-25 18:52:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Version-Control.html" > Coding using Version Control< / a > < ul >
2022-11-14 22:43:45 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Version-Control.html#setting-up-git" > Setting up Git< / a > < / li >
2022-11-25 18:52:52 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Version-Control.html#common-git-commands" > Common Git commands< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Version-Control.html#putting-your-game-dir-under-version-control" > Putting your game dir under version control< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Version-Control.html#contributing-to-evennia" > Contributing to Evennia< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Version-Control.html#troubleshooting" > Troubleshooting< / a > < / li >
2022-11-20 23:39:28 +00:00
< / ul >
< / li >
2022-11-14 22:43:45 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Debugging.html" > Debugging< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Debugging.html#debugging-evennia" > Debugging Evennia< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Debugging.html#a-simple-example-using-pdb" > A simple example using pdb< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Debugging.html#cheat-sheet-of-pdb-pudb-commands" > Cheat-sheet of pdb/pudb commands< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Unit-Testing.html" > Unit Testing< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Unit-Testing.html#running-the-evennia-test-suite" > Running the Evennia test suite< / a > < / li >
2022-11-25 22:54:04 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Unit-Testing.html#running-custom-game-dir-unit-tests" > Running custom game-dir unit tests< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Unit-Testing.html#writing-new-unit-tests" > Writing new unit tests< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Profiling.html" > Profiling< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Profiling.html#simple-timer-tests" > Simple timer tests< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Profiling.html#using-cprofile" > Using cProfile< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Profiling.html#the-dummyrunner" > The Dummyrunner< / a > < / li >
< / ul >
< / li >
2022-11-25 20:28:54 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Continuous-Integration.html" > Continuous Integration (CI)< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Continuous-Integration.html#continuous-integration-guides" > Continuous-Integration guides< / a > < / li >
2022-11-25 18:52:52 +00:00
< / ul >
< / li >
2022-11-25 20:28:54 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Setting-up-PyCharm.html" > Setting up PyCharm with Evennia< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Setting-up-PyCharm.html#debug-evennia-from-inside-pycharm" > Debug Evennia from inside PyCharm< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Setting-up-PyCharm.html#run-evennia-from-inside-pycharm" > Run Evennia from inside PyCharm< / a > < / li >
2022-11-14 22:43:45 +01:00
< / ul >
< / li >
< / ul >
< / div >
2022-11-23 21:21:51 +00:00
< section id = "evennia-changelog" >
< h2 > Evennia Changelog< a class = "headerlink" href = "#evennia-changelog" title = "Permalink to this headline" > ¶< / a > < / h2 >
2022-11-23 23:07:10 +00:00
< div class = "toctree-wrapper compound" >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "Changelog.html" > Changelog< / a > < ul >
2023-08-15 07:19:16 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#main-branch" > Main branch< / a > < / li >
2023-08-06 22:05:11 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-2-2-0" > Evennia 2.2.0< / a > < / li >
2023-07-14 13:23:27 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-2-1-0" > Evennia 2.1.0< / a > < / li >
2023-06-17 07:26:48 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-2-0-1" > Evennia 2.0.1< / a > < / li >
2023-06-11 13:34:12 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-2-0-0" > Evennia 2.0.0< / a > < / li >
2023-04-29 06:58:57 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-3-0" > Evennia 1.3.0< / a > < / li >
2023-02-26 19:29:26 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-2-1" > Evennia 1.2.1< / a > < / li >
2023-02-25 16:50:58 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-2-0" > Evennia 1.2.0< / a > < / li >
2023-01-15 21:50:49 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-1-1" > Evennia 1.1.1< / a > < / li >
2023-01-07 22:31:19 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-1-0" > Evennia 1.1.0< / a > < / li >
2022-12-21 16:40:45 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-0-2" > Evennia 1.0.2< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-0-1" > Evennia 1.0.1< / a > < / li >
2023-01-07 22:31:19 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-1-0-0" > Evennia 1.0.0< / a > < / li >
2022-11-23 23:07:10 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-0-9-5" > Evennia 0.9.5< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-0-9" > Evennia 0.9< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#evennia-0-8" > Evennia 0.8< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Changelog.html#overview-changelogs" > Overview-Changelogs< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#sept-2017" > Sept 2017:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#feb-2017" > Feb 2017:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#dec-2016" > Dec 2016:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#may-2016" > May 2016:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#feb-2016" > Feb 2016:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#sept-2015" > Sept 2015:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#feb-2015" > Feb 2015:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#sept-2014" > Sept 2014:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#jan-2014" > Jan 2014:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#nov-2013" > Nov 2013:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#may-2013" > May 2013:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#oct-2012" > Oct 2012:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#march-2012" > March 2012:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#nov-2011" > Nov 2011:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#aug-2011" > Aug 2011:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#may-2011" > May 2011:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#aug-2010" > Aug 2010:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#may-2010" > May 2010:< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "Changelog.html#april-2010" > April 2010:< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Changelog.html#older" > Older< / a > < / li >
< / ul >
2022-11-23 21:21:51 +00:00
< / div >
2022-12-01 21:58:35 +00:00
< div class = "toctree-wrapper compound" >
< / div >
2022-11-23 21:21:51 +00:00
< / section >
2022-11-14 22:43:45 +01:00
< / section >
< / div >
< / div >
< / div >
< / div >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< 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" >
2022-11-25 20:28:54 +00:00
< a href = "Evennia-Code-Style.html" title = "Evennia Code Style"
2022-11-14 22:43:45 +01:00
>next< / a > |< / li >
< li class = "right" >
2022-11-26 14:42:25 +00:00
< a href = "../Concepts/Zones.html" title = "Zones"
2022-11-14 22:43:45 +01:00
>previous< / a > |< / li >
2023-06-10 07:57:46 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-this" > < a href = "" > Coding and development help< / a > < / li >
< / ul >
< / div >
2023-06-10 08:53:19 +00:00
2022-11-14 22:43:45 +01:00
< div class = "footer" role = "contentinfo" >
2023-02-26 22:34:19 +00:00
© Copyright 2023, The Evennia developer community.
2022-11-14 22:43:45 +01:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
