mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 22:06:30 +01:00
166 lines
No EOL
8 KiB
HTML
166 lines
No EOL
8 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Using Travis — Evennia 0.9.5 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>
|
||
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Game Planning" href="Game-Planning.html" />
|
||
<link rel="prev" title="Using MUX as a Standard" href="Using-MUX-as-a-Standard.html" />
|
||
</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>
|
||
<li class="right" >
|
||
<a href="Game-Planning.html" title="Game Planning"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="Using-MUX-as-a-Standard.html" title="Using MUX as a Standard"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="Developer-Central.html" accesskey="U">Developer Central</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Using Travis</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="using-travis">
|
||
<h1>Using Travis<a class="headerlink" href="#using-travis" title="Permalink to this headline">¶</a></h1>
|
||
<p>Evennia uses <a class="reference external" href="http://travis-ci.org/">Travis CI</a> to check that it’s building successfully after every
|
||
commit to its Github repository (you can for example see the <code class="docutils literal notranslate"><span class="pre">build:</span> <span class="pre">passing</span></code> badge at the top of
|
||
Evennia’s <a class="reference external" href="https://github.com/evennia/evennia">Readme file</a>). If your game is open source on Github
|
||
you may use Travis for free. See <a class="reference external" href="http://docs.travis-ci.com/user/getting-started/">the Travis docs</a>
|
||
for how to get started.</p>
|
||
<p>After logging in you need to point Travis to your repository on github. One further thing you need
|
||
to set up yourself is a Travis config file named <code class="docutils literal notranslate"><span class="pre">.travis.yml</span></code> (note the initial period <code class="docutils literal notranslate"><span class="pre">.</span></code>). This
|
||
should be created in the <em>root</em> of your game directory.</p>
|
||
<div class="highlight-yaml notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
|
||
2
|
||
3
|
||
4
|
||
5
|
||
6
|
||
7
|
||
8
|
||
9
|
||
10
|
||
11
|
||
12
|
||
13
|
||
14
|
||
15</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="nt">dist</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">xenial</span>
|
||
<span class="nt">language</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">python</span>
|
||
<span class="nt">cache</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">pip</span>
|
||
|
||
<span class="nt">python</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="s">"3.7"</span>
|
||
<span class="p p-Indicator">-</span> <span class="s">"3.8"</span>
|
||
|
||
<span class="nt">install</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">git clone https://github.com/evennia/evennia.git ../evennia</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">pip install -e ../evennia</span>
|
||
|
||
<span class="nt">script</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">evennia test --settings settings.py</span>
|
||
|
||
</pre></div>
|
||
</td></tr></table></div>
|
||
<p>Here we tell Travis how to download and install Evennia into a folder a level up from your game dir.
|
||
It will then install the server (so the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command is available) and run the tests only for
|
||
your game dir (based on your <code class="docutils literal notranslate"><span class="pre">settings.py</span></code> file in <code class="docutils literal notranslate"><span class="pre">server/conf/</span></code>).</p>
|
||
<p>Running this will not actually do anything though, because there are no unit tests in your game dir
|
||
yet. <a class="reference internal" href="Unit-Testing.html"><span class="doc">We have a page</span></a> on how we set those up for Evennia, you should be able to refer
|
||
to that for making tests fitting your game.</p>
|
||
</div>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</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>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="Using-MUX-as-a-Standard.html"
|
||
title="previous chapter">Using MUX as a Standard</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="Game-Planning.html"
|
||
title="next chapter">Game Planning</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/Using-Travis.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="Using-Travis.html">0.9.5 (v0.9.5 branch)</a></li>
|
||
</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>
|
||
<li class="right" >
|
||
<a href="Game-Planning.html" title="Game Planning"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="Using-MUX-as-a-Standard.html" title="Using MUX as a Standard"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="Developer-Central.html" >Developer Central</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Using Travis</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |