mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
224 lines
No EOL
11 KiB
HTML
224 lines
No EOL
11 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>Clickable links — Evennia latest documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
|
|
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<link rel="icon" href="../_static/favicon.ico"/>
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
<link rel="next" title="Inline functions" href="Inline-Functions.html" />
|
|
<link rel="prev" title="Colors" href="Colors.html" />
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="right" >
|
|
<a href="Inline-Functions.html" title="Inline functions"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="Colors.html" title="Colors"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="Concepts-Overview.html" >Core Concepts</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="Tags-Parsed-By-Evennia.html" accesskey="U">In-text tags parsed by Evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Clickable links</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="clickable-links">
|
|
<h1>Clickable links<a class="headerlink" href="#clickable-links" title="Link to this heading">¶</a></h1>
|
|
<p>Evennia allows for clickable links in text for clients that supports it. This marks certain text so it can be clicked by a mouse and either trigger a given Evennia command, or open a URL in an external web browser. To see clickable links, the player must use the Evennia webclient or a third-party telnet client with <a class="reference external" href="http://www.zuggsoft.com/zmud/mxp.htm">MXP</a> support (<em>Note: Evennia only supports clickable links, no other MXP features</em>).</p>
|
|
<p>Users with clients lacking MXP support will only see the link as normal text.</p>
|
|
<div class="admonition important">
|
|
<p class="admonition-title">Important</p>
|
|
<p>By default, clickable links can <em>not</em> be added from in-game. Trying to do so will have the link come back as normal text. This is a security measure. See <a class="reference internal" href="#settings">Settings</a> for more information.</p>
|
|
</div>
|
|
<section id="click-to-run-a-command">
|
|
<h2>Click to run a command<a class="headerlink" href="#click-to-run-a-command" title="Link to this heading">¶</a></h2>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">|</span><span class="n">lc</span> <span class="n">command</span> <span class="o">|</span><span class="n">lt</span> <span class="n">text</span> <span class="o">|</span><span class="n">le</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Example:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"If you go |lcnorth|ltto the north|le you will find a cottage."</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>This will display as “If you go <strong>to the north</strong> you will find a cottage.” where clicking the link will execute the command <code class="docutils literal notranslate"><span class="pre">north</span></code>.</p>
|
|
</section>
|
|
<section id="click-to-open-an-url-in-a-web-browser">
|
|
<h2>Click to open an url in a web browser<a class="headerlink" href="#click-to-open-an-url-in-a-web-browser" title="Link to this heading">¶</a></h2>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">|</span><span class="n">lu</span> <span class="n">url</span> <span class="o">|</span><span class="n">lt</span> <span class="n">text</span> <span class="o">|</span><span class="n">le</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Example:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"Omnious |luhttps://mycoolsounds.com/chanting|ltchanting sounds|le are coming from beyond the door."</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>This will show as “Omnious <strong>chanting sounds</strong> are coming from beyond the door”, where clicking the link will open the url in a browser if the client supports doing so.</p>
|
|
</section>
|
|
<section id="settings">
|
|
<h2>Settings<a class="headerlink" href="#settings" title="Link to this heading">¶</a></h2>
|
|
<p>Enable / disable MXP overall (enabled by default).</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">MXP_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>By default help entries have clickable topics.</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">HELP_CLICKABLE_TOPICS</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>By default clickable links are only available <em>from strings provided in code</em> (or via a <a class="reference internal" href="../Components/Batch-Processors.html"><span class="std std-doc">batch script</span></a>). You <em>cannot</em> create clickable links from inside the game - the result will not come out as clickable.</p>
|
|
<p>This is a security measure. Consider if a user were able to enter clickable links in their description, like this:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>|lc give 1000 gold to Bandit |ltClick here to read my backstory!|le
|
|
</pre></div>
|
|
</div>
|
|
<p>This would be executed by the poor player clicking the link, resulting in them paying 1000 gold to the bandit.</p>
|
|
<p>This is controlled by the following default setting:</p>
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">MXP_OUTGOING_ONLY</span> <span class="o">=</span> <span class="kc">True</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Only disable this protection if you know your game cannot be exploited in this way.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../index.html">
|
|
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
|
|
</a></p>
|
|
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|
<h3><a href="../index.html">Table of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">Clickable links</a><ul>
|
|
<li><a class="reference internal" href="#click-to-run-a-command">Click to run a command</a></li>
|
|
<li><a class="reference internal" href="#click-to-open-an-url-in-a-web-browser">Click to open an url in a web browser</a></li>
|
|
<li><a class="reference internal" href="#settings">Settings</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="Colors.html"
|
|
title="previous chapter">Colors</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="Inline-Functions.html"
|
|
title="next chapter">Inline functions</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<!--h3>This Page</h3-->
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/Concepts/Clickable-Links.md.txt"
|
|
rel="nofollow">Show Page Source</a></li>
|
|
</ul>
|
|
</div><h3>Links</h3>
|
|
<ul>
|
|
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
|
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
|
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
|
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
|
<li>
|
|
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
|
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
|
<a href="https://evennia.blogspot.com/">Blog</a>
|
|
</li>
|
|
</ul>
|
|
<h3>Doc Versions</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
|
|
</li>
|
|
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="right" >
|
|
<a href="Inline-Functions.html" title="Inline functions"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="Colors.html" title="Colors"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="Concepts-Overview.html" >Core Concepts</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="Tags-Parsed-By-Evennia.html" >In-text tags parsed by Evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Clickable links</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |