evennia/docs/1.0-dev/Coding/Coding-Overview.html

182 lines
8.8 KiB
HTML
Raw Normal View History

2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
<html>
2020-07-14 00:21:00 +02:00
<head>
<meta charset="utf-8" />
2021-05-16 00:06:01 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
2020-07-14 00:21:00 +02:00
<title>Coding and development help &#8212; Evennia 1.0-dev documentation</title>
<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>
2021-10-26 21:41:11 +02:00
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
2020-07-14 00:21:00 +02:00
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
2020-10-19 22:46:24 +02:00
<link rel="search" title="Search" href="../search.html" />
2022-01-08 16:38:41 +01:00
<link rel="next" title="Contribs" href="../Contribs/Contrib-Overview.html" />
2021-10-26 21:41:11 +02:00
<link rel="prev" title="Default Commands" href="../Components/Default-Commands.html" />
2020-07-14 00:21:00 +02:00
</head><body>
<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>
2020-10-19 22:46:24 +02:00
<li class="right" >
2022-01-08 16:38:41 +01:00
<a href="../Contribs/Contrib-Overview.html" title="Contribs"
2020-10-19 22:46:24 +02:00
accesskey="N">next</a> |</li>
<li class="right" >
2021-10-26 21:41:11 +02:00
<a href="../Components/Default-Commands.html" title="Default Commands"
2020-10-19 22:46:24 +02:00
accesskey="P">previous</a> |</li>
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Coding and development help</a></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
2020-07-14 00:21:00 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
2021-10-26 21:41:11 +02:00
<section class="tex2jax_ignore mathjax_ignore" id="coding-and-development-help">
2020-07-14 00:21:00 +02:00
<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
make your game, also if you never coded before. If you are an experienced coder, much of this will be familiar
to you, but some things may still be useful.</p>
2021-05-16 00:06:01 +02:00
<section id="find-your-way">
2020-07-14 00:21:00 +02:00
<h2>Find your way<a class="headerlink" href="#find-your-way" title="Permalink to this headline"></a></h2>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="../Howto/Starting/Part1/Gamedir-Overview.html"><span class="doc std std-doc">Directory-Overview</span></a></p></li>
<li><p><a class="reference internal" href="Quirks.html"><span class="doc std std-doc">Quirks of Evennia</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-05-16 00:06:01 +02:00
</section>
<section id="setting-up-a-workflow">
2020-07-14 00:21:00 +02:00
<h2>Setting up a workflow<a class="headerlink" href="#setting-up-a-workflow" title="Permalink to this headline"></a></h2>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Setting-up-PyCharm.html"><span class="doc std std-doc">Setting up PyCharm</span></a></p></li>
<li><p><a class="reference internal" href="Version-Control.html"><span class="doc std std-doc">Using Version-Control</span></a></p></li>
<li><p><a class="reference internal" href="Updating-Your-Game.html"><span class="doc std std-doc">Updating Evennia sources</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-05-16 00:06:01 +02:00
</section>
<section id="coding-away">
2020-07-14 00:21:00 +02:00
<h2>Coding away<a class="headerlink" href="#coding-away" title="Permalink to this headline"></a></h2>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Coding-Introduction.html"><span class="doc std std-doc">Coding Introduction</span></a></p></li>
<li><p><a class="reference internal" href="Debugging.html"><span class="doc std std-doc">Ways to Debug</span></a></p></li>
<li><p><a class="reference internal" href="Unit-Testing.html"><span class="doc std std-doc">Adding unit-tests</span></a></p></li>
<li><p><a class="reference internal" href="Flat-API.html"><span class="doc std std-doc">Things to remember when importing from evennia</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-05-16 00:06:01 +02:00
</section>
<section id="advanced-concepts">
2020-07-14 00:21:00 +02:00
<h2>Advanced concepts<a class="headerlink" href="#advanced-concepts" title="Permalink to this headline"></a></h2>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Continuous-Integration.html"><span class="doc std std-doc">Continuous Integration</span></a></p>
2020-07-14 00:21:00 +02:00
<ul>
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Using-Travis.html"><span class="doc std std-doc">Using Travis</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
</li>
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Profiling.html"><span class="doc std std-doc">Profiling</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-05-16 00:06:01 +02:00
</section>
</section>
2020-07-14 00:21:00 +02:00
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
2020-07-14 00:21:00 +02:00
</div>
</div>
</div>
<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>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Coding and development help</a><ul>
<li><a class="reference internal" href="#find-your-way">Find your way</a></li>
<li><a class="reference internal" href="#setting-up-a-workflow">Setting up a workflow</a></li>
<li><a class="reference internal" href="#coding-away">Coding away</a></li>
<li><a class="reference internal" href="#advanced-concepts">Advanced concepts</a></li>
</ul>
</li>
</ul>
2020-10-19 22:46:24 +02:00
<h4>Previous topic</h4>
2021-10-26 21:41:11 +02:00
<p class="topless"><a href="../Components/Default-Commands.html"
title="previous chapter">Default Commands</a></p>
2020-10-19 22:46:24 +02:00
<h4>Next topic</h4>
<p class="topless"><a href="../Contribs/Contrib-Overview.html"
2022-01-08 16:38:41 +01:00
title="next chapter">Contribs</a></p>
2020-07-14 00:21:00 +02: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>
2021-03-06 01:37:43 +01:00
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
2021-08-06 00:47:51 +02:00
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
2021-08-06 00:53:44 +02:00
<a href="https://evennia.blogspot.com/">Blog</a>
2021-03-06 01:37:43 +01:00
</li>
</ul>
2020-07-14 00:21:00 +02:00
<h3>Versions</h3>
<ul>
<li><a href="Coding-Overview.html">1.0-dev (develop branch)</a></li>
2022-02-05 18:41:59 +00:00
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
2020-07-14 00:21:00 +02:00
</ul>
</div>
</div>
<div class="clearer"></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>
2020-10-19 22:46:24 +02:00
<li class="right" >
2022-01-08 16:38:41 +01:00
<a href="../Contribs/Contrib-Overview.html" title="Contribs"
2020-10-19 22:46:24 +02:00
>next</a> |</li>
<li class="right" >
2021-10-26 21:41:11 +02:00
<a href="../Components/Default-Commands.html" title="Default Commands"
2020-10-19 22:46:24 +02:00
>previous</a> |</li>
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Coding and development help</a></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
2020-07-14 00:21:00 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
2020-07-14 00:21:00 +02:00
</div>
</body>
</html>