mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 22:06:30 +01:00
177 lines
No EOL
9.2 KiB
HTML
177 lines
No EOL
9.2 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>Text Encodings — 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>
|
||
<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>
|
||
<link rel="shortcut icon" href="_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.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="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Text Encodings</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section class="tex2jax_ignore mathjax_ignore" id="text-encodings">
|
||
<h1>Text Encodings<a class="headerlink" href="#text-encodings" title="Permalink to this headline">¶</a></h1>
|
||
<p>Evennia is a text-based game server. This makes it important to understand how
|
||
it actually deals with data in the form of text.</p>
|
||
<p>Text <em>byte encodings</em> describe how a string of text is actually stored in the
|
||
computer - that is, the particular sequence of bytes used to represent the
|
||
letters of your particular alphabet. A common encoding used in English-speaking
|
||
languages is the <em>ASCII</em> encoding. This describes the letters in the English
|
||
alphabet (Aa-Zz) as well as a bunch of special characters. For describing other
|
||
character sets (such as that of other languages with other letters than
|
||
English), sets with names such as <em>Latin-1</em>, <em>ISO-8859-3</em> and <em>ARMSCII-8</em>
|
||
are used. There are hundreds of different byte encodings in use around the
|
||
world.</p>
|
||
<p>A string of letters in a byte encoding is represented with the <code class="docutils literal notranslate"><span class="pre">bytes</span></code> type.
|
||
In contrast to the byte encoding is the <em>unicode representation</em>. In Python
|
||
this is the <code class="docutils literal notranslate"><span class="pre">str</span></code> type. The unicode is an internationally agreed-upon table
|
||
describing essentially all available letters you could ever want to print.
|
||
Everything from English to Chinese alphabets and all in between. So what
|
||
Evennia (as well as Python and Django) does is to store everything in Unicode
|
||
internally, but then converts the data to one of the encodings whenever
|
||
outputting data to the user.</p>
|
||
<p>An easy memory aid is that <code class="docutils literal notranslate"><span class="pre">bytes</span></code> are what are sent over the network wire. At
|
||
all other times, <code class="docutils literal notranslate"><span class="pre">str</span></code> (unicode) is used. This means that we must convert
|
||
between the two at the points where we send/receive network data.</p>
|
||
<p>The problem is that when receiving a string of bytes over the network it’s
|
||
impossible for Evennia to guess which encoding was used - it’s just a bunch of
|
||
bytes! Evennia must know the encoding in order to convert back and from the
|
||
correct unicode representation.</p>
|
||
<section id="how-to-customize-encodings">
|
||
<h2>How to customize encodings<a class="headerlink" href="#how-to-customize-encodings" title="Permalink to this headline">¶</a></h2>
|
||
<p>As long as you stick to the standard ASCII character set (which means the
|
||
normal English characters, basically) you should not have to worry much
|
||
about this section.</p>
|
||
<p>If you want to build your game in another language however, or expect your
|
||
users to want to use special characters not in ASCII, you need to consider
|
||
which encodings you want to support.</p>
|
||
<p>As mentioned, there are many, many byte-encodings used around the world. It
|
||
should be clear at this point that Evennia can’t guess but has to assume or
|
||
somehow be told which encoding you want to use to communicate with the server.
|
||
Basically the encoding used by your client must be the same encoding used by
|
||
the server. This can be customized in two complementary ways.</p>
|
||
<ol class="simple">
|
||
<li><p>Point users to the default <code class="docutils literal notranslate"><span class="pre">@encoding</span></code> command or the <code class="docutils literal notranslate"><span class="pre">@options</span></code> command.
|
||
This allows them to themselves set which encoding they (and their client of
|
||
choice) uses. Whereas data will remain stored as unicode strings internally in
|
||
Evennia, all data received from and sent to this particular player will be
|
||
converted to the given format before transmitting.</p></li>
|
||
<li><p>As a back-up, in case the user-set encoding translation is erroneous or
|
||
fails in some other way, Evennia will fall back to trying with the names
|
||
defined in the settings variable <code class="docutils literal notranslate"><span class="pre">ENCODINGS</span></code>. This is a list of encoding
|
||
names Evennia will try, in order, before giving up and giving an encoding
|
||
error message.</p></li>
|
||
</ol>
|
||
<p>Note that having to try several different encodings every input/output adds
|
||
unneccesary overhead. Try to guess the most common encodings you players will
|
||
use and make sure these are tried first. The International <em>UTF-8</em> encoding is
|
||
what Evennia assumes by default (and also what Python/Django use normally). See
|
||
the Wikipedia article <a class="reference external" href="http://en.wikipedia.org/wiki/Text_encodings">here</a> for more help.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<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>
|
||
<p><h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Text Encodings</a><ul>
|
||
<li><a class="reference internal" href="#how-to-customize-encodings">How to customize encodings</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/Text-Encodings.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</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>
|
||
<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>
|
||
</li>
|
||
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
|
||
</ul>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="Text-Encodings.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="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Text Encodings</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> |