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 > IRC — 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 = "" > IRC< / 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 = "irc" >
2020-06-13 00:36:45 +02:00
< h1 > IRC< a class = "headerlink" href = "#irc" title = "Permalink to this headline" > ¶< / a > < / h1 >
2020-06-16 22:49:43 +02:00
< p > < em > Disambiguation: This page is related to using IRC inside an Evennia game. To join the official
2021-10-26 21:41:11 +02:00
Evennia IRC chat, connect to < a class = "reference external" href = "http://irc.freenode.net" > irc.freenode.net< / a > and join #evennia. Alternatively, you can < a class = "reference external" href = "https://discord.gg/NecFePw" > join our
2020-06-16 22:49:43 +02:00
Discord< / a > , which is mirrored to IRC.< / em > < / p >
2021-08-06 00:47:51 +02:00
< p > < a class = "reference external" href = "https://en.wikipedia.org/wiki/Internet_Relay_Chat" > IRC (Internet Relay Chat)< / a > is a long standing
2020-06-16 22:49:43 +02:00
chat protocol used by many open-source projects for communicating in real time. By connecting one of
2021-10-26 21:41:11 +02:00
Evennia’ < a class = "reference internal" href = "../Components/Communications.html" > < span class = "doc std std-doc" > Channels< / span > < / a > to an IRC channel you can communicate also with people not on
2020-06-16 22:49:43 +02:00
an mud themselves. You can also use IRC if you are only running your Evennia MUD locally on your
computer (your game doesn’
2021-08-06 00:47:51 +02:00
For IRC operation you also need < a class = "reference external" href = "https://twistedmatrix.com/trac/wiki/TwistedWords" > twisted.words< / a > .
2020-06-16 22:49:43 +02:00
This is available simply as a package < em > python-twisted-words< / em > in many Linux distros, or directly
downloadable from the link.< / p >
2021-05-16 00:06:01 +02:00
< section id = "configuring-irc" >
2020-06-13 00:36:45 +02:00
< h2 > Configuring IRC< a class = "headerlink" href = "#configuring-irc" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To configure IRC, you’ < / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > IRC_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 >
2020-06-16 22:49:43 +02:00
< p > Start Evennia and log in as a privileged user. You should now have a new command available:
< code class = "docutils literal notranslate" > < span class = "pre" > @ irc2chan< / 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 > @irc2chan[/switches] < evennia_channel> = < ircnetwork> < port> < #irchannel> < botname>
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > If you already know how IRC works, this should be pretty self-evident to use. Read the help entry
for more features.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "setting-up-irc-step-by-step" >
2020-06-13 00:36:45 +02:00
< h2 > Setting up IRC, step by step< a class = "headerlink" href = "#setting-up-irc-step-by-step" title = "Permalink to this headline" > ¶< / a > < / h2 >
2020-06-16 22:49:43 +02:00
< p > You can connect IRC to any Evennia channel (so you could connect it to the default < em > public< / em > channel
if you like), but for testing, let’ < code class = "docutils literal notranslate" > < span class = "pre" > irc< / span > < / code > .< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @ccreate irc = This is connected to an irc channel!
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > You will automatically join the new channel.< / p >
2020-06-16 22:49:43 +02:00
< p > Next we will create a connection to an external IRC network and channel. There are many, many IRC
2021-08-06 00:47:51 +02:00
nets. < a class = "reference external" href = "https://www.irchelp.org/networks/popular.html" > Here is a list< / a > of some of the biggest
2020-06-16 22:49:43 +02:00
ones, the one you choose is not really very important unless you want to connect to a particular
channel (also make sure that the network allows for “bots” to connect).< / p >
< p > For testing, we choose the < em > Freenode< / em > network, < code class = "docutils literal notranslate" > < span class = "pre" > irc.freenode.net< / span > < / code > . We will connect to a test
channel, let’ < em > #myevennia-test< / em > (an IRC channel always begins with < code class = "docutils literal notranslate" > < span class = "pre" > #< / span > < / code > ). It’
pick an obscure channel name that didn’ ’
for you.< / p >
2020-06-13 00:36:45 +02:00
< blockquote >
2020-06-16 22:49:43 +02:00
< div > < p > < em > Don’ < / em > connect to < code class = "docutils literal notranslate" > < span class = "pre" > #evennia< / span > < / code > for testing and debugging, that is Evennia’
You < em > are< / em > welcome to connect your game to < code class = "docutils literal notranslate" > < span class = "pre" > #evennia< / span > < / code > once you have everything working though - it
can be a good way to get help and ideas. But if you do, please do so with an in-game channel open
only to your game admins and developers).< / p >
2020-06-13 00:36:45 +02:00
< / div > < / blockquote >
< p > The < em > port< / em > needed depends on the network. For Freenode this is < code class = "docutils literal notranslate" > < span class = "pre" > 6667< / span > < / code > .< / p >
2020-06-16 22:49:43 +02:00
< p > What will happen is that your Evennia server will connect to this IRC channel as a normal user. This
“user” (or “bot”) needs a name, which you must also supply. Let’ < / p >
< p > To test that the bot connects correctly you also want to log onto this channel with a separate,
third-party IRC client. There are hundreds of such clients available. If you use Firefox, the
< em > Chatzilla< / em > plugin is good and easy. Freenode also offers its own web-based chat page. Once you
have connected to a network, the command to join is usually < code class = "docutils literal notranslate" > < span class = "pre" > /join< / span > < span class = "pre" > #channelname< / span > < / code > (don’
#).< / p >
2020-06-13 00:36:45 +02:00
< p > Next we connect Evennia with the IRC channel.< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > @irc2chan irc = irc.freenode.net 6667 #myevennia-test mud-bot
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > Evennia will now create a new IRC bot < code class = "docutils literal notranslate" > < span class = "pre" > mud-bot< / span > < / code > and connect it to the IRC network and the channel
#myevennia. If you are connected to the IRC channel you will soon see the user < em > mud-bot< / em > connect.< / p >
2020-06-13 00:36:45 +02:00
< p > Write something in the Evennia channel < em > irc< / em > .< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > irc Hello, World!
2020-06-13 00:36:45 +02:00
[irc] Anna: Hello, World!
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > If you are viewing your IRC channel with a separate IRC client you should see your text appearing
there, spoken by the bot:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > mud-bot> [irc] Anna: Hello, World!
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
2020-06-16 22:49:43 +02:00
< p > Write < code class = "docutils literal notranslate" > < span class = "pre" > Hello!< / span > < / code > in your IRC client window and it will appear in your normal channel, marked with the
name of the IRC channel you used (#evennia here).< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-none notranslate" > < div class = "highlight" > < pre > < span > < / span > [irc] Anna@#myevennia-test: Hello!
2020-06-13 00:36:45 +02:00
< / pre > < / div >
< / div >
< p > Your Evennia gamers can now chat with users on external IRC 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 = "#" > IRC< / a > < ul >
< li > < a class = "reference internal" href = "#configuring-irc" > Configuring IRC< / a > < / li >
< li > < a class = "reference internal" href = "#setting-up-irc-step-by-step" > Setting up IRC, 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/IRC.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 = "IRC.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 = "" > IRC< / 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 >
