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
76 lines
3.0 KiB
HTML
76 lines
3.0 KiB
HTML
<h2 style="margin:0 0 .5rem 0">What it does</h2>
|
||
<p>
|
||
<code>/encounter</code> adds a single encounter to the pirate’s history. These entries feed the
|
||
threat score so the pirate list reflects how dangerous someone actually is right now.
|
||
</p>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Form fields</h2>
|
||
<ul>
|
||
<li><b>Pirate (name or account)</b><br>
|
||
Best: <code>Name#12345</code>. If you only know the character name, it must match exactly and not be ambiguous.
|
||
</li>
|
||
<li><b>Group size</b><br>
|
||
Integer <b>≥ 1</b>. How many pirates were in their group, including the reported pirate.
|
||
</li>
|
||
<li><b>Kills</b><br>
|
||
Integer <b>≥ 0</b>. Use 0 for none/unknown.
|
||
</li>
|
||
<li><b>Destructive?</b><br>
|
||
<code>yes</code>/<code>no</code>. “Yes” if a base/ornithopter was destroyed, etc.
|
||
</li>
|
||
<li><b>Perceived Skill</b><br>
|
||
<b>0–5</b>. Use 0 if you’re unsure. 5 = cracked aim/sweaty movement, 1–2 = casual.
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="usage" style="margin:.6rem 0 0">
|
||
/encounter MuadDib#12345 · group 3 · kills 1 · destructive yes · skill 4
|
||
</div>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Validation & messages</h2>
|
||
<ul>
|
||
<li>If the account format is wrong, you’ll be told what to fix (<code>Name#12345</code> ending with five digits).</li>
|
||
<li>Character names must be an exact match. If multiple pirates share that name, you’ll be asked to use the account.</li>
|
||
<li><b>Rate limit:</b> one report per user per pirate every <b>10 minutes</b>.</li>
|
||
<li>You’ll see a private <b>“Encounter recorded”</b> confirmation on success.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">How threat is calculated (short)</h2>
|
||
<p>
|
||
Each encounter contributes to a weighted score (0–100):
|
||
</p>
|
||
<ul>
|
||
<li><b>Kills</b>: higher if the pirate gets kills.</li>
|
||
<li><b>Destructive</b>: higher if they destroy stuff.</li>
|
||
<li><b>Group size</b>: higher if they roll with <code>group ≥ T</code> (T comes from config).</li>
|
||
<li><b>Skill</b>: your 0–5 rating normalized and averaged across encounters.</li>
|
||
</ul>
|
||
<p>
|
||
The weights are configurable (defaults: Kill 0.35, Destruction 0.30, Group 0.20, Skill 0.15). After you submit,
|
||
the bot recomputes the pirate’s <b>threat level</b> and <b>encounter count</b>, then refreshes the list.
|
||
</p>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Tips</h2>
|
||
<ul>
|
||
<li>Use the account (<code>Name#12345</code>) whenever possible — it guarantees the report hits the right person.</li>
|
||
<li>If you can’t tell skill, leave it at 0. That’s fine.</li>
|
||
<li>Group size includes the pirate you’re reporting.</li>
|
||
</ul>
|
||
|
||
<hr>
|
||
|
||
<h2 style="margin:.75rem 0 .5rem">Common errors</h2>
|
||
<ul>
|
||
<li><b>“No such pirate registered.”</b> — Ask a mod to add them, or submit a <code>/report</code> first.</li>
|
||
<li><b>“Character name is ambiguous.”</b> — Use the account tag (<code>Name#12345</code>).</li>
|
||
<li><b>“You can only report the same pirate once every 10 minutes.”</b> — Wait a bit and try again.</li>
|
||
</ul>
|