<title>The Show Art Module | ENiGMA½ BBS Software</title>
<metaname="generator"content="Jekyll v4.2.1"/>
<metaproperty="og:title"content="The Show Art Module"/>
<metaproperty="og:locale"content="en_US"/>
<metaname="description"content="The Show Art Module The built in show_art module add some advanced ways in which you can configure your system to display art assets beyond what a standard menu entry can provide. For example, based on user selection of a file or message base area."/>
<metaproperty="og:description"content="The Show Art Module The built in show_art module add some advanced ways in which you can configure your system to display art assets beyond what a standard menu entry can provide. For example, based on user selection of a file or message base area."/>
{"mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/modding/show-art.html"},"description":"The Show Art Module The built in show_art module add some advanced ways in which you can configure your system to display art assets beyond what a standard menu entry can provide. For example, based on user selection of a file or message base area.","url":"/enigma-bbs/modding/show-art.html","@type":"BlogPosting","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"headline":"The Show Art Module","dateModified":"2022-11-28T04:11:10+00:00","datePublished":"2022-11-28T04:11:10+00:00","@context":"https://schema.org"}</script>
<aclass="btn"style="float: right;margin-left: 20px"href="/enigma-bbs/modding/file-base-download-manager.html">File Base Download Manager »</a>
<brclear="both"/>
</div>
<divclass="page">
<h1class="page-title">The Show Art Module</h1>
<h2id="the-show-art-module">The Show Art Module</h2>
<p>The built in <codeclass="language-plaintext highlighter-rouge">show_art</code> module add some advanced ways in which you can configure your system to display art assets beyond what a standard menu entry can provide. For example, based on user selection of a file or message base area.</p>
<li><codeclass="language-plaintext highlighter-rouge">method</code>: Set the method in which to show art. See <strong>Methods</strong> below.</li>
<li><codeclass="language-plaintext highlighter-rouge">optional</code>: Is this art required or optional? If non-optional and we cannot show art based on <codeclass="language-plaintext highlighter-rouge">method</code>, it is an error.</li>
<li><codeclass="language-plaintext highlighter-rouge">key</code>: Used for some <codeclass="language-plaintext highlighter-rouge">method</code>s. See <strong>Methods</strong></li>
</ul>
<h3id="methods">Methods</h3>
<h4id="extra-args">Extra Args</h4>
<p>When <codeclass="language-plaintext highlighter-rouge">method</code> is <codeclass="language-plaintext highlighter-rouge">extraArgs</code>, the module selects an <em>art spec</em> from a value found within <codeclass="language-plaintext highlighter-rouge">extraArgs</code> that were passed to <codeclass="language-plaintext highlighter-rouge">show_art</code> by <codeclass="language-plaintext highlighter-rouge">key</code>. Consider the following:</p>
<p>Given an <codeclass="language-plaintext highlighter-rouge">menu.hjson</code> entry:</p>
<p>If the <codeclass="language-plaintext highlighter-rouge">showWithExtraArgs</code> menu was entered and passed <codeclass="language-plaintext highlighter-rouge">extraArgs</code> as the following:</p>
<p>…then the system would use the <em>art spec</em> of <codeclass="language-plaintext highlighter-rouge">LOLART</code>.</p>
<h4id="area--conferences">Area & Conferences</h4>
<p>Handy for inserting into File Base, Message Conferences, or Mesage Area selections selections. When <codeclass="language-plaintext highlighter-rouge">method</code> is <codeclass="language-plaintext highlighter-rouge">fileBaseArea</code>, <codeclass="language-plaintext highlighter-rouge">messageConf</code>, or <codeclass="language-plaintext highlighter-rouge">messageArea</code> the selected conf/area’s associated <em>art spec</em> is utilized. Example:</p>
<p>Given a file base entry in <codeclass="language-plaintext highlighter-rouge">config.hjson</code>:</p>
<p>…if the user choose the “All Your Base” area, the <em>art spec</em> of <codeclass="language-plaintext highlighter-rouge">ALLBASE</code> would be selected and displayed.</p>
<p>The only difference for <codeclass="language-plaintext highlighter-rouge">messageConf</code> or <codeclass="language-plaintext highlighter-rouge">messageArea</code> methods are where the art is defined (which is always next to the conf or area declaration in <codeclass="language-plaintext highlighter-rouge">config.hjson</code>).</p>
<p>While <codeclass="language-plaintext highlighter-rouge">key</code> can be overridden, the system uses <codeclass="language-plaintext highlighter-rouge">areaTag</code> for message/file area selections, and <codeclass="language-plaintext highlighter-rouge">confTag</code> for conference selections by default.</p>
