2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
< html >
2020-06-15 21:52:33 +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/" / >
2021-10-26 21:41:11 +02:00
< title > Using Travis — Evennia 0.95 documentation< / title >
2020-06-15 21:52:33 +02: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 >
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-06-13 23:31:27 +02:00
< link rel = "shortcut icon" href = "_static/favicon.ico" / >
2020-06-15 21:52:33 +02:00
< link rel = "index" title = "Index" href = "genindex.html" / >
2021-10-26 21:41:11 +02:00
< link rel = "search" title = "Search" href = "search.html" / >
2020-06-15 21:52:33 +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 >
2021-10-26 21:41:11 +02:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Evennia 0.95< / a > » < / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-this" > < a href = "" > Using Travis< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2020-06-13 00:36:45 +02:00
2021-10-26 21:41:11 +02:00
< section class = "tex2jax_ignore mathjax_ignore" id = "using-travis" >
2020-06-13 00:36:45 +02:00
< h1 > Using Travis< a class = "headerlink" href = "#using-travis" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-10-11 22:19:29 +02:00
< p > Evennia uses < a class = "reference external" href = "http://travis-ci.org/" > Travis CI< / a > to check that it’
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’ < 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 >
2021-10-26 21:41:11 +02:00
< div class = "highlight-yaml notranslate" > < 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 >
2020-10-11 22:19:29 +02:00
< 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 >
2020-06-13 00:36:45 +02:00
< span class = "nt" > python< / span > < span class = "p" > :< / span >
2020-10-11 22:19:29 +02:00
< span class = "p p-Indicator" > -< / span > < span class = "s" > " 3.7" < / span >
< span class = "p p-Indicator" > -< / span > < span class = "s" > " 3.8" < / span >
2020-06-13 00:36:45 +02:00
< span class = "nt" > install< / span > < span class = "p" > :< / span >
2020-10-11 22:19:29 +02:00
< 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 >
2020-06-13 00:36:45 +02:00
< span class = "nt" > script< / span > < span class = "p" > :< / span >
2020-10-11 22:19:29 +02:00
< span class = "p p-Indicator" > -< / span > < span class = "l l-Scalar l-Scalar-Plain" > evennia test --settings settings.py< / span >
2020-06-13 00:36:45 +02:00
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2020-10-11 22:19:29 +02:00
< 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
2021-10-26 21:41:11 +02:00
yet. < a class = "reference internal" href = "Unit-Testing.html" > < span class = "doc std std-doc" > We have a page< / span > < / a > on how we set those up for Evennia, you should be able to refer
2020-10-11 22:19:29 +02:00
to that for making tests fitting your game.< / p >
2021-05-16 00:06:01 +02:00
< / section >
2020-06-13 00:36:45 +02:00
2020-10-15 01:31:30 +02:00
< div class = "clearer" > < / div >
2020-06-13 00:36:45 +02:00
< / div >
< / div >
< / div >
2020-06-15 21:52:33 +02:00
< 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 >
< 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 >
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-10-14 21:39:33 +02:00
< li > < a href = "http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb" > IRC< / a > -
< a href = "https://discord.gg/NecFePw" > Discord< / a > -
< a href = "https://groups.google.com/forum/#%21forum/evennia" > Forums< / a >
2021-03-06 01:37:43 +01:00
< / li >
2021-10-14 21:39:33 +02:00
< li > < a href = "http://evennia.blogspot.com/" > Evennia Dev blog< / a > < / li >
2021-03-06 01:37:43 +01:00
< / ul >
2020-06-15 21:52:33 +02:00
< h3 > Versions< / h3 >
< ul >
2020-07-14 00:21:00 +02:00
< li > < a href = "../1.0-dev/index.html" > 1.0-dev (develop branch)< / a > < / li >
2021-10-26 21:41:11 +02:00
< li > < a href = "Using-Travis.html" > 0.95 (v0.9.5 branch)< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2020-06-13 00:36:45 +02:00
2021-10-14 21:39:33 +02:00
2020-06-15 21:52:33 +02:00
< / 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 >
2021-10-26 21:41:11 +02:00
< li class = "nav-item nav-item-0" > < a href = "index.html" > Evennia 0.95< / a > » < / li >
2020-10-15 01:31:30 +02:00
< li class = "nav-item nav-item-this" > < a href = "" > Using Travis< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
< / div >
< div class = "footer" role = "contentinfo" >
© 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-06-15 21:52:33 +02:00
< / div >
< / body >
2020-06-13 00:36:45 +02:00
< / html >
