<metaname="description"content="The TopX Module The built in top_x module allows for displaying oLDSKOOL (?!) top user stats for the week, month, etc. Ops can configure what stat(s) are displayed and how far back in days the stats are considered."/>
<metaproperty="og:description"content="The TopX Module The built in top_x module allows for displaying oLDSKOOL (?!) top user stats for the week, month, etc. Ops can configure what stat(s) are displayed and how far back in days the stats are considered."/>
{"mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/modding/top-x.html"},"description":"The TopX Module The built in top_x module allows for displaying oLDSKOOL (?!) top user stats for the week, month, etc. Ops can configure what stat(s) are displayed and how far back in days the stats are considered.","url":"/enigma-bbs/modding/top-x.html","@type":"BlogPosting","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"headline":"TopX","dateModified":"2022-11-28T04:11:10+00:00","datePublished":"2022-11-28T04:11:10+00:00","@context":"https://schema.org"}</script>
<p>The built in <codeclass="language-plaintext highlighter-rouge">top_x</code> module allows for displaying oLDSKOOL (?!) top user stats for the week, month, etc. Ops can configure what stat(s) are displayed and how far back in days the stats are considered.</p>
<li><codeclass="language-plaintext highlighter-rouge">mciMap</code>: Supplies a mapping of MCI code to data source. See <codeclass="language-plaintext highlighter-rouge">mciMap</code> below.</li>
</ul>
<h4id="mci-map-mcimap">MCI Map (mciMap)</h4>
<p>The <codeclass="language-plaintext highlighter-rouge">mciMap</code><codeclass="language-plaintext highlighter-rouge">config</code> block configures MCI code mapping to data sources. Currently the following data sources (determined by <codeclass="language-plaintext highlighter-rouge">type</code>) are available:</p>
<p>When <codeclass="language-plaintext highlighter-rouge">type</code> is set to <codeclass="language-plaintext highlighter-rouge">userEventLog</code>, entries from the User Event Log can be counted (ie: individual instances of a particular log item) or summed in the case of log items that have numeric values. The default is to sum.</p>
<p>Some current User Event Log <codeclass="language-plaintext highlighter-rouge">value</code> examples include <codeclass="language-plaintext highlighter-rouge">ul_files</code>, <codeclass="language-plaintext highlighter-rouge">dl_file_bytes</code>, or <codeclass="language-plaintext highlighter-rouge">achievement_earned</code>. See <ahref="https://github.com/NuSkooler/enigma-bbs/blob/master/core/user_log_name.js">user_log_name.js</a> for additional information./user_log_name.jsEry:</p>
<p>When <codeclass="language-plaintext highlighter-rouge">type</code> is set to <codeclass="language-plaintext highlighter-rouge">userProp</code>, data is collected from individual user’s properties. For example a <codeclass="language-plaintext highlighter-rouge">value</code> of <codeclass="language-plaintext highlighter-rouge">minutes_online_total_count</code>. See <ahref="https://github.com/NuSkooler/enigma-bbs/blob/master/core/user_property.js">user_property.js</a> for more information.</p>
value: minutes_online_total_count // top users by minutes spent on the board
}
}
</code></pre>
<h2id="theming">Theming</h2>
<p>Generally <codeclass="language-plaintext highlighter-rouge">mciMap</code> entries will point to a Vertical List View Menu (<codeclass="language-plaintext highlighter-rouge">%VM1</code>, <codeclass="language-plaintext highlighter-rouge">%VM2</code>, etc.). The following <codeclass="language-plaintext highlighter-rouge">itemFormat</code> object is provided:</p>
<ul>
<li><codeclass="language-plaintext highlighter-rouge">value</code>: The value acquired from the supplied data source.</li>
<li><codeclass="language-plaintext highlighter-rouge">affils</code> or <codeclass="language-plaintext highlighter-rouge">affiliation</code>: Users affiliations.</li>
<li><codeclass="language-plaintext highlighter-rouge">position</code>: Rank position (numeric).</li>
</ul>
<p>Remember that string format rules apply, so for example, if displaying top uploaded bytes (<codeclass="language-plaintext highlighter-rouge">ul_file_bytes</code>), a <codeclass="language-plaintext highlighter-rouge">itemFormat</code> may be <codeclass="language-plaintext highlighter-rouge">{userName} - {value!sizeWithAbbr}</code> yielding something like “TopDude - 4 GB”. See <ahref="/enigma-bbs/art/mci.html">MCI</a> for additional information.</p>
</div>
<divclass="PageNavigation">
<aclass="btn"style="float:left;margin-right: 20px;"href="/enigma-bbs/modding/node-msg.html">« Node to Node Messaging</a>
