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/" / >
2020-06-15 21:52:33 +02:00
< title > Grapevine — Evennia 1.0-dev documentation< / title >
2020-07-14 00:21:00 +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-07-14 00:21:00 +02:00
< link rel = "shortcut icon" href = "../_static/favicon.ico" / >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< 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" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
accesskey="I">index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / 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 > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Grapevine< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / 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 = "grapevine" >
2020-06-13 00:36:45 +02:00
< h1 > Grapevine< a class = "headerlink" href = "#grapevine" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-08-06 00:47:51 +02:00
< p > < a class = "reference external" href = "https://grapevine.haus" > Grapevine< / a > is a new chat network for < code class = "docutils literal notranslate" > < span class = "pre" > MU*< / span > < / code > *** games. By
2020-06-13 00:36:45 +02:00
connecting an in-game channel to the grapevine network, players on your game
can chat with players in other games, also non-Evennia ones.< / p >
2021-05-16 00:06:01 +02:00
< section id = "configuring-grapevine" >
2020-06-13 00:36:45 +02:00
< h2 > Configuring Grapevine< a class = "headerlink" href = "#configuring-grapevine" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To use Grapevine, you first need the < code class = "docutils literal notranslate" > < span class = "pre" > pyopenssl< / span > < / code > module. Install it into your
Evennia python environment with< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > pip install pyopenssl
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > To configure Grapevine, you’ < / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > GRAPEVINE_ENABLED< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span >
2020-06-13 00:36:45 +02:00
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
< p > Next, register an account at < a class = "reference external" href = "https://grapevine.haus" > https://grapevine.haus< / a > . When you have logged in,
2020-06-13 00:36:45 +02:00
go to your Settings/Profile and to the < code class = "docutils literal notranslate" > < span class = "pre" > Games< / span > < / code > sub menu. Here you register your
new game by filling in its information. At the end of registration you are going
to get a < code class = "docutils literal notranslate" > < span class = "pre" > Client< / span > < span class = "pre" > ID< / span > < / code > and a < code class = "docutils literal notranslate" > < span class = "pre" > Client< / span > < span class = "pre" > Secret< / span > < / code > . These should not be shared.< / p >
< p > Open/create the file < code class = "docutils literal notranslate" > < span class = "pre" > mygame/server/conf/secret_settings.py< / span > < / code > and add the following:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > GRAPEVINE_CLIENT_ID< / span > < span class = "o" > =< / span > < span class = "s2" > " < client ID> " < / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > GRAPEVINE_CLIENT_SECRET< / span > < span class = "o" > =< / span > < span class = "s2" > " < client_secret> " < / span >
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2020-06-13 00:36:45 +02:00
< p > You can also customize the Grapevine channels you are allowed to connect to. This
is added to the < code class = "docutils literal notranslate" > < span class = "pre" > GRAPEVINE_CHANNELS< / span > < / code > setting. You can see which channels are available
2021-10-26 21:41:11 +02:00
by going to the Grapevine online chat here: < a class = "reference external" href = "https://grapevine.haus/chat" > https://grapevine.haus/chat< / a > .< / p >
2020-06-13 00:36:45 +02:00
< p > Start/reload Evennia and log in as a privileged user. You should now have a new
command available: < code class = "docutils literal notranslate" > < span class = "pre" > @ grapevine2chan< / span > < / code > . This command is called like this:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @grapevine2chan[/switches] < evennia_channel> = < grapevine_channel>
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > Here, the < code class = "docutils literal notranslate" > < span class = "pre" > evennia_channel< / span > < / code > must be the name of an existing Evennia channel and
< code class = "docutils literal notranslate" > < span class = "pre" > grapevine_channel< / span > < / code > one of the supported channels in < code class = "docutils literal notranslate" > < span class = "pre" > GRAPEVINE_CHANNELS< / span > < / code > .< / p >
< blockquote >
< div > < p > At the time of writing, the Grapevine network only has two channels:
< code class = "docutils literal notranslate" > < span class = "pre" > testing< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > gossip< / span > < / code > . Evennia defaults to allowing connecting to both. Use
< code class = "docutils literal notranslate" > < span class = "pre" > testing< / span > < / code > for trying your connection.< / p >
< / div > < / blockquote >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "setting-up-grapevine-step-by-step" >
2020-06-13 00:36:45 +02:00
< h2 > Setting up Grapevine, step by step< a class = "headerlink" href = "#setting-up-grapevine-step-by-step" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > You can connect Grapevine to any Evennia channel (so you could connect it to
the default < em > public< / em > channel if you like), but for testing, let’
new channel < code class = "docutils literal notranslate" > < span class = "pre" > gw< / span > < / code > .< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @ccreate gw = This is connected to an gw channel!
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > You will automatically join the new channel.< / p >
< p > Next we will create a connection to the Grapevine network.< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @grapevine2chan gw = gossip
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > Evennia will now create a new connection and connect it to Grapevine. Connect
2021-10-26 21:41:11 +02:00
to < a class = "reference external" href = "https://grapevine.haus/chat" > https://grapevine.haus/chat< / a > to check.< / p >
2020-06-13 00:36:45 +02:00
< p > Write something in the Evennia channel < em > gw< / em > and check so a message appears in
the Grapevine chat. Write a reply in the chat and the grapevine bot should echo
it to your channel in-game.< / p >
< p > Your Evennia gamers can now chat with users on external Grapevine channels!< / p >
2021-05-16 00:06:01 +02:00
< / section >
< / 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" >
2020-07-14 00:21:00 +02:00
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/evennia_logo.png" alt = "Logo" / >
2020-06-15 21:52:33 +02:00
< / a > < / p >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
2020-07-14 00:21:00 +02:00
< form class = "search" action = "../search.html" method = "get" >
2020-06-15 21:52:33 +02:00
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
2020-07-14 00:21:00 +02:00
< p > < h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
2020-06-15 21:52:33 +02:00
< ul >
< li > < a class = "reference internal" href = "#" > Grapevine< / a > < ul >
< li > < a class = "reference internal" href = "#configuring-grapevine" > Configuring Grapevine< / a > < / li >
< li > < a class = "reference internal" href = "#setting-up-grapevine-step-by-step" > Setting up Grapevine, step by step< / a > < / li >
< / ul >
< / li >
< / ul >
2020-06-13 00:36:45 +02:00
2020-06-15 21:52:33 +02:00
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
2020-07-14 00:21:00 +02:00
< li > < a href = "../_sources/Setup/Grapevine.md.txt"
2020-06-15 21:52:33 +02:00
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-06-15 21:52:33 +02:00
< h3 > Versions< / h3 >
< ul >
< li > < a href = "Grapevine.html" > 1.0-dev (develop branch)< / a > < / li >
< / ul >
2020-06-14 21:48:02 +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" >
2020-07-14 00:21:00 +02:00
< a href = "../genindex.html" title = "General Index"
2020-06-15 21:52:33 +02:00
>index< / a > < / li >
< li class = "right" >
2020-07-14 00:21:00 +02:00
< a href = "../py-modindex.html" title = "Python Module Index"
2020-06-15 21:52:33 +02:00
>modules< / 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 > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Grapevine< / a > < / li >
2020-06-15 21:52:33 +02:00
< / ul >
2021-06-23 18:58:26 +02:00
< div class = "develop" > develop branch< / div >
2020-06-15 21:52:33 +02:00
< / 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 >
