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 > Custom Protocols — 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 = "" > Custom Protocols< / 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 = "custom-protocols" >
2020-06-13 00:36:45 +02:00
< h1 > Custom Protocols< a class = "headerlink" href = "#custom-protocols" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > < em > Note: This is considered an advanced topic and is mostly of interest to users planning to implement
their own custom client protocol.< / em > < / p >
2021-10-26 21:41:11 +02:00
< p > A < a class = "reference internal" href = "../Components/Sessions.html#portal-and-server-sessions" > < span class = "std std-doc" > PortalSession< / span > < / a > is the basic data object representing an
2020-06-16 22:49:43 +02:00
external
2021-10-26 21:41:11 +02:00
connection to the Evennia < a class = "reference internal" href = "../Components/Portal-And-Server.html" > < span class = "doc std std-doc" > Portal< / span > < / a > –
2020-06-13 00:36:45 +02:00
of some kind. The way they connect (the language the player’
each other) is called the connection < em > Protocol< / em > . The most common such protocol for MUD:s is the
< em > Telnet< / em > protocol. All Portal Sessions are stored and managed by the Portal’ < em > sessionhandler< / em > .< / p >
< p > It’ < em > PortalSession< / em > from the concept of
2020-06-16 22:49:43 +02:00
< em > Protocol< / em > since both depend heavily on the other (they are often created as the same class). When
data flows through this part of the system, this is how it goes< / p >
2020-06-13 00:36:45 +02:00
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # In the Portal< / span >
< span class = "n" > You< / span > < span class = "o" > < -> < / span >
< span class = "n" > Protocol< / span > < span class = "o" > +< / span > < span class = "n" > PortalSession< / span > < span class = "o" > < -> < / span >
< span class = "n" > PortalSessionHandler< / span > < span class = "o" > < -> < / span >
< span class = "p" > (< / span > < span class = "n" > AMP< / span > < span class = "p" > )< / span > < span class = "o" > < -> < / span >
< span class = "n" > ServerSessionHandler< / span > < span class = "o" > < -> < / span >
< span class = "n" > ServerSession< / span > < span class = "o" > < -> < / span >
< span class = "n" > InputFunc< / span >
< / pre > < / div >
< / div >
2021-10-26 21:41:11 +02:00
< p > (See the < a class = "reference internal" href = "Messagepath.html" > < span class = "doc std std-doc" > Message Path< / span > < / a > for the bigger picture of how data flows through Evennia). The
2020-06-16 22:49:43 +02:00
parts that needs to be customized to make your own custom protocol is the < code class = "docutils literal notranslate" > < span class = "pre" > Protocol< / span > < span class = "pre" > +< / span > < span class = "pre" > PortalSession< / span > < / code >
(which translates between data coming in/out over the wire to/from Evennia internal representation)
as well as the < code class = "docutils literal notranslate" > < span class = "pre" > InputFunc< / span > < / code > (which handles incoming data).< / p >
2021-05-16 00:06:01 +02:00
< section id = "adding-custom-protocols" >
2020-06-13 00:36:45 +02:00
< h2 > Adding custom Protocols< a class = "headerlink" href = "#adding-custom-protocols" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Evennia has a plugin-system that add the protocol as a new “service” to the application.< / p >
< p > Take a look at < code class = "docutils literal notranslate" > < span class = "pre" > evennia/server/portal/portal.py< / span > < / code > , notably the sections towards the end of that file.
These are where the various in-built services like telnet, ssh, webclient etc are added to the
Portal (there is an equivalent but shorter list in < code class = "docutils literal notranslate" > < span class = "pre" > evennia/server/server.py< / span > < / code > ).< / p >
< p > To add a new service of your own (for example your own custom client protocol) to the Portal or
Server, look at < code class = "docutils literal notranslate" > < span class = "pre" > mygame/server/conf/server_services_plugins< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > portal_services_plugins< / span > < / code > . By
default Evennia will look into these modules to find plugins. If you wanted to have it look for more
modules, you could do the following:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # add to the Server< / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > SERVER_SERVICES_PLUGIN_MODULES< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "s1" > ' server.conf.my_server_plugins' < / span > < span class = "p" > )< / span >
< span class = "c1" > # or, if you want to add to the Portal< / span >
< span class = "n" > PORTAL_SERVICES_PLUGIN_MODULES< / span > < span class = "o" > .< / span > < span class = "n" > append< / span > < span class = "p" > (< / span > < span class = "s1" > ' server.conf.my_portal_plugins' < / span > < span class = "p" > )< / span >
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2020-06-16 22:49:43 +02:00
< p > When adding a new connection you’
< code class = "docutils literal notranslate" > < span class = "pre" > PORTAL_SERVICES_PLUGIN_MODULES< / span > < / code > .< / p >
2020-06-13 00:36:45 +02:00
< p > This module can contain whatever you need to define your protocol, but it < em > must< / em > contain a function
< code class = "docutils literal notranslate" > < span class = "pre" > start_plugin_services(app)< / span > < / code > . This is called by the Portal as part of its upstart. The function
< code class = "docutils literal notranslate" > < span class = "pre" > start_plugin_services< / span > < / code > must contain all startup code the server need. The < code class = "docutils literal notranslate" > < span class = "pre" > app< / span > < / code > argument is a
reference to the Portal/Server application itself so the custom service can be added to it. The
function should not return anything.< / p >
< p > This is how it looks:< / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # mygame/server/conf/portal_services_plugins.py< / span >
2020-06-13 00:36:45 +02:00
< span class = "c1" > # here the new Portal Twisted protocol is defined< / span >
< span class = "k" > class< / span > < span class = "nc" > MyOwnFactory< / span > < span class = "p" > (< / span > < span class = "o" > ...< / span > < span class = "p" > ):< / span >
< span class = "p" > [< / span > < span class = "o" > ...< / span > < span class = "p" > ]< / span >
< span class = "c1" > # some configs< / span >
2020-12-20 14:36:24 +01:00
< span class = "n" > MYPROC_ENABLED< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "c1" > # convenient off-flag to avoid having to edit settings all the time< / span >
2020-06-13 00:36:45 +02:00
< span class = "n" > MY_PORT< / span > < span class = "o" > =< / span > < span class = "mi" > 6666< / span >
< span class = "k" > def< / span > < span class = "nf" > start_plugin_services< / span > < span class = "p" > (< / span > < span class = "n" > portal< / span > < span class = "p" > ):< / span >
< span class = "s2" > " This is called by the Portal during startup" < / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > MYPROC_ENABLED< / span > < span class = "p" > :< / span >
< span class = "k" > return< / span >
< span class = "c1" > # output to list this with the other services at startup< / span >
2021-10-14 21:39:33 +02:00
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > " myproc: < / span > < span class = "si" > {< / span > < span class = "n" > MY_PORT< / span > < span class = "si" > }< / span > < span class = "s2" > " < / span > < span class = "p" > )< / span >
2020-06-13 00:36:45 +02:00
< span class = "c1" > # some setup (simple example)< / span >
< span class = "n" > factory< / span > < span class = "o" > =< / span > < span class = "n" > MyOwnFactory< / span > < span class = "p" > ()< / span >
< span class = "n" > my_service< / span > < span class = "o" > =< / span > < span class = "n" > internet< / span > < span class = "o" > .< / span > < span class = "n" > TCPServer< / span > < span class = "p" > (< / span > < span class = "n" > MY_PORT< / span > < span class = "p" > ,< / span > < span class = "n" > factory< / span > < span class = "p" > )< / span >
< span class = "c1" > # all Evennia services must be uniquely named< / span >
< span class = "n" > my_service< / span > < span class = "o" > .< / span > < span class = "n" > setName< / span > < span class = "p" > (< / span > < span class = "s2" > " MyService" < / span > < span class = "p" > )< / span >
< span class = "c1" > # add to the main portal application< / span >
< span class = "n" > portal< / span > < span class = "o" > .< / span > < span class = "n" > services< / span > < span class = "o" > .< / span > < span class = "n" > addService< / span > < span class = "p" > (< / span > < span class = "n" > my_service< / span > < span class = "p" > )< / span >
< / pre > < / div >
2021-10-26 21:41:11 +02:00
< / div >
2020-06-13 00:36:45 +02:00
< p > Once the module is defined and targeted in settings, just reload the server and your new
protocol/services should start with the others.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "writing-your-own-protocol" >
2020-06-13 00:36:45 +02:00
< h2 > Writing your own Protocol< a class = "headerlink" href = "#writing-your-own-protocol" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Writing a stable communication protocol from scratch is not something we’ ’
trivial task. The good news is that Twisted offers implementations of many common protocols, ready
for adapting.< / p >
2020-06-16 22:49:43 +02:00
< p > Writing a protocol implementation in Twisted usually involves creating a class inheriting from an
already existing Twisted protocol class and from < code class = "docutils literal notranslate" > < span class = "pre" > evennia.server.session.Session< / span > < / code > (multiple
inheritance), then overloading the methods that particular protocol uses to link them to the
Evennia-specific inputs.< / p >
2020-06-13 00:36:45 +02:00
< p > Here’ < / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # In module that we' ll later add to the system through PORTAL_SERVICE_PLUGIN_MODULES< / span >
2020-06-13 00:36:45 +02:00
< span class = "c1" > # pseudo code < / span >
< span class = "kn" > from< / span > < span class = "nn" > twisted.something< / span > < span class = "kn" > import< / span > < span class = "n" > TwistedClient< / span >
< span class = "c1" > # this class is used both for Portal- and Server Sessions< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.server.session< / span > < span class = "kn" > import< / span > < span class = "n" > Session< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.server.portal.portalsessionhandler< / span > < span class = "kn" > import< / span > < span class = "n" > PORTAL_SESSIONS< / span >
< span class = "k" > class< / span > < span class = "nc" > MyCustomClient< / span > < span class = "p" > (< / span > < span class = "n" > TwistedClient< / span > < span class = "p" > ,< / span > < span class = "n" > Session< / span > < span class = "p" > ):< / span >
< span class = "k" > def< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "fm" > __init__< / span > < span class = "p" > (< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > =< / span > < span class = "n" > PORTAL_SESSIONS< / span >
< span class = "c1" > # these are methods we must know that TwistedClient uses for < / span >
< span class = "c1" > # communication. Name and arguments could vary for different Twisted protocols< / span >
< span class = "k" > def< / span > < span class = "nf" > onOpen< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # let' s say this is called when the client first connects< / span >
< span class = "c1" > # we need to init the session and connect to the sessionhandler. The .factory< / span >
< span class = "c1" > # is available through the Twisted parents< / span >
< span class = "n" > client_address< / span > < span class = "o" > =< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > getClientAddress< / span > < span class = "p" > ()< / span > < span class = "c1" > # get client address somehow< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > init_session< / span > < span class = "p" > (< / span > < span class = "s2" > " mycustom_protocol" < / span > < span class = "p" > ,< / span > < span class = "n" > client_address< / span > < span class = "p" > ,< / span > < span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > factory< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "p" > )< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > connect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > onClose< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > reason< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called when the client connection is dropped< / span >
< span class = "c1" > # link to the Evennia equivalent< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > disconnect< / span > < span class = "p" > (< / span > < span class = "n" > reason< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > onMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > indata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called with incoming data< / span >
< span class = "c1" > # convert as needed here < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_in< / span > < span class = "p" > (< / span > < span class = "n" > data< / span > < span class = "o" > =< / span > < span class = "n" > indata< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > sendMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > outdata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "c1" > # called to send data out< / span >
< span class = "c1" > # modify if needed < / span >
< span class = "nb" > super< / span > < span class = "p" > ()< / span > < span class = "o" > .< / span > < span class = "n" > sendMessage< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > outdata< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > )< / span >
< span class = "c1" > # these are Evennia methods. They must all exist and look exactly like this< / span >
< span class = "c1" > # The above twisted-methods call them and vice-versa. This connects the protocol< / span >
< span class = "c1" > # the Evennia internals. < / span >
2020-12-20 14:36:24 +01:00
< span class = "k" > def< / span > < span class = "nf" > disconnect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > reason< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
2020-06-13 00:36:45 +02:00
< span class = "sd" > " " " < / span >
< span class = "sd" > Called when connection closes. < / span >
< span class = "sd" > This can also be called directly by Evennia when manually closing the connection.< / span >
< span class = "sd" > Do any cleanups here.< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > disconnect< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > at_login< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Called when this session authenticates by the server (if applicable)< / span >
< span class = "sd" > " " " < / span >
< span class = "k" > def< / span > < span class = "nf" > data_in< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Data going into the server should go through this method. It < / span >
< span class = "sd" > should pass data into `sessionhandler.data_in`. THis will be called< / span >
< span class = "sd" > by the sessionhandler with the data it gets from the approrpriate < / span >
< span class = "sd" > send_* method found later in this protocol. < / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > sessionhandler< / span > < span class = "o" > .< / span > < span class = "n" > data_in< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "n" > kwargs< / span > < span class = "p" > [< / span > < span class = "s1" > ' data' < / span > < span class = "p" > ])< / span >
< span class = "k" > def< / span > < span class = "nf" > data_out< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Data going out from the server should go through this method. It should< / span >
< span class = "sd" > hand off to the protocol' s send method, whatever it' s called.< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # we assume we have a ' text' outputfunc< / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > onMessage< / span > < span class = "p" > (< / span > < span class = "n" > kwargs< / span > < span class = "p" > [< / span > < span class = "s1" > ' text' < / span > < span class = "p" > ])< / span >
< span class = "c1" > # ' outputfuncs' are defined as `send_< outputfunc_name> `. From in-code, they are called < / span >
< span class = "c1" > # with `msg(outfunc_name=< data> )`. < / span >
< span class = "k" > def< / span > < span class = "nf" > send_text< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > txt< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Send text, used with e.g. `session.msg(text=" foo" )`< / span >
< span class = "sd" > " " " < / span >
< span class = "c1" > # we make use of the < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_out< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "n" > txt< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > send_default< / span > < span class = "p" > (< / span > < span class = "bp" > self< / span > < span class = "p" > ,< / span > < span class = "n" > cmdname< / span > < span class = "p" > ,< / span > < span class = "o" > *< / span > < span class = "n" > args< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "n" > kwargs< / span > < span class = "p" > ):< / span >
< span class = "sd" > " " " < / span >
< span class = "sd" > Handles all outputfuncs without an explicit `send_*` method to handle them.< / span >
< span class = "sd" > " " " < / span >
< span class = "bp" > self< / span > < span class = "o" > .< / span > < span class = "n" > data_out< / span > < span class = "p" > (< / span > < span class = "o" > **< / span > < span class = "p" > {< / span > < span class = "n" > cmdname< / span > < span class = "p" > :< / span > < span class = "nb" > str< / span > < span class = "p" > (< / span > < span class = "n" > args< / span > < span class = "p" > )})< / span >
2021-10-26 21:41:11 +02:00
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 > The principle here is that the Twisted-specific methods are overridden to redirect inputs/outputs to
the Evennia-specific methods.< / p >
2021-05-16 00:06:01 +02:00
< section id = "sending-data-out" >
2020-06-13 00:36:45 +02:00
< h3 > Sending data out< a class = "headerlink" href = "#sending-data-out" title = "Permalink to this headline" > ¶< / a > < / h3 >
< p > To send data out through this protocol, you’ < / p >
2021-10-26 21:41:11 +02:00
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > session< / span > < span class = "o" > .< / span > < span class = "n" > msg< / span > < span class = "p" > (< / span > < span class = "n" > text< / span > < span class = "o" > =< / span > < span class = "s2" > " foo" < / span > < span class = "p" > )< / 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 > The message will pass through the system such that the sessionhandler will dig out the session and
check if it has a < code class = "docutils literal notranslate" > < span class = "pre" > send_text< / span > < / code > method (it has). It will then pass the “foo” into that method, which
in our case means sending “foo” across the network.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< section id = "receiving-data" >
2020-06-13 00:36:45 +02:00
< h3 > Receiving data< a class = "headerlink" href = "#receiving-data" title = "Permalink to this headline" > ¶< / a > < / h3 >
2020-06-16 22:49:43 +02:00
< p > Just because the protocol is there, does not mean Evennia knows what to do with it. An
2021-10-26 21:41:11 +02:00
< a class = "reference internal" href = "../Components/Inputfuncs.html" > < span class = "doc std std-doc" > Inputfunc< / span > < / a > must exist to receive it. In the case of the < code class = "docutils literal notranslate" > < span class = "pre" > text< / span > < / code > input exemplified above,
2020-06-16 22:49:43 +02:00
Evennia alredy handles this input - it will parse it as a Command name followed by its inputs. So
handle that you need to simply add a cmdset with commands on your receiving Session (and/or the
Object/Character it is puppeting). If not you may need to add your own Inputfunc (see the
2021-10-26 21:41:11 +02:00
< a class = "reference internal" href = "../Components/Inputfuncs.html" > < span class = "doc std std-doc" > Inputfunc< / span > < / a > page for how to do this.< / p >
2020-06-13 00:36:45 +02:00
< p > These might not be as clear-cut in all protocols, but the principle is there. These four basic
components - however they are accessed - links to the < em > Portal Session< / em > , which is the actual common
interface between the different low-level protocols and Evennia.< / p >
2021-05-16 00:06:01 +02:00
< / section >
< / section >
< section id = "assorted-notes" >
2020-06-13 00:36:45 +02:00
< h2 > Assorted notes< a class = "headerlink" href = "#assorted-notes" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > To take two examples, Evennia supports the < em > telnet< / em > protocol as well as < em > webclient< / em > , via ajax or
websockets. You’
above, the ajax protocol looks quite different due to how it interacts with the
webserver through long-polling (comet) style requests. All the necessary parts
mentioned above are still there, but by necessity implemented in very different
ways.< / 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 = "#" > Custom Protocols< / a > < ul >
< li > < a class = "reference internal" href = "#adding-custom-protocols" > Adding custom Protocols< / a > < / li >
< li > < a class = "reference internal" href = "#writing-your-own-protocol" > Writing your own Protocol< / a > < ul >
< li > < a class = "reference internal" href = "#sending-data-out" > Sending data out< / a > < / li >
< li > < a class = "reference internal" href = "#receiving-data" > Receiving data< / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#assorted-notes" > Assorted notes< / 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/Concepts/Custom-Protocols.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 = "Custom-Protocols.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 = "" > Custom Protocols< / 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 >
