fdd336fe91
- Doc site UI improvements and fixes
- Added Discord widget
- Fixed some styling issues
- Added command docs briefs and details
- Briefs are shown in the right-hand panel
- Details can be shown by clicking `Open full details`
- Added ShaiWatchers' logo as the site favicon
- Moved HTML template to static file for responsiveness improvements
56 lines
2.2 KiB
HTML
56 lines
2.2 KiB
HTML
<h2 style="margin:0 0 .5rem 0">What it does</h2>
|
||
<ul>
|
||
<li>Builds a compact, alphabetized list of verified pirates and posts it in the configured list channel.</li>
|
||
<li>Entries are chunked to stay under Discord’s 2000-character limit; old chunks are edited or deleted as needed.</li>
|
||
<li>No one gets pinged — all content is sanitized to avoid accidental mentions.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Entry format</h2>
|
||
<pre style="margin:.5rem 0;white-space:pre-wrap">
|
||
- <b>Character</b> (<i>Account#12345</i>) [Threat%]
|
||
- In group: <i>bucket</i>. Destructive: <i>bucket</i>. Encounters: N. Last: <t:UNIX:R>
|
||
</pre>
|
||
<ul>
|
||
<li><b>Threat%</b> reflects combined encounter signals (kills, destructive behavior, group size, skill).</li>
|
||
<li><b>In group / Destructive</b> use buckets: <code>unknown</code>, <code>never</code>, <code>rarely</code>, <code>sometimes</code>, <code>often</code>, <code>always</code>.</li>
|
||
<li><b>Last</b> shows the most recent encounter as a relative timestamp.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">When to use</h2>
|
||
<ul>
|
||
<li>After a new pirate is approved or removed.</li>
|
||
<li>After logging encounters that meaningfully change threat or buckets.</li>
|
||
<li>When the list looks stale or out of order.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Behavior & notes</h2>
|
||
<ul>
|
||
<li>Sorts by character name, then account.</li>
|
||
<li>If there are no pirates yet, shows a single placeholder line.</li>
|
||
<li>If the list channel isn’t configured or can’t be found, nothing is posted (check your config).</li>
|
||
<li>Per-guild cooldown: 10 seconds (prevents spam).</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Config that affects output</h2>
|
||
<ul>
|
||
<li><code>pirates_list_channel_id</code> — where the list is posted.</li>
|
||
<li><code>threat_group_threshold</code> — minimum party size that counts as “in group”.</li>
|
||
<li><code>threat_min_samples_for_stats</code> — encounters needed before buckets stop showing <code>unknown</code>.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Permissions</h2>
|
||
<ul>
|
||
<li><b>Moderator-only.</b></li>
|
||
<li>Bot needs permission to read and write in the list channel.</li>
|
||
</ul>
|