shaiwatcher/assets/docs/commands/DDLootTableCog.dd_update.details.html
Franz Rolfsvaag 1ede582a76 0.4.2.0.a1
- DD cycle data fetching
  - ShaiWatcher will now keep an updated loot table of the unique items in the DD each week
    The bot will **only** edit its message if already present, which should reduce message spam
  - Added command `/dd_update` to control the update behaviour. stop|resume|start [reason_text]
- Docsite changes
  - Added "ADMIN" tags to commands, signifying owner-only commands
  - Owner-only commands are now filtered under the "moderator" category
  - Added docs for `/dd_update`
- Logging
  - Added logging info for more verbose info relating to configuration and installation
2025-08-16 06:39:01 +02:00

51 lines
2.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1>/dd_update — Deep Desert updater controls</h1>
<p>Manage the weekly “Deep Desert — Weekly Uniques” message updater for this guild.</p>
<h2>Usage</h2>
<pre>/dd_update &lt;action&gt; [reason]</pre>
<ul>
<li><code>action</code><code>stop</code> | <code>resume</code> | <code>start</code></li>
<li><code>reason</code> (optional) — free text appended to the confirmation response.</li>
</ul>
<h2>Permissions</h2>
<ul>
<li><strong>stop</strong> / <strong>resume</strong>: Server Owner or members with <em>Manage Server</em>.</li>
<li><strong>start</strong>: <em>Server Owner only</em>. Use with care—this forces an immediate check cycle.</li>
</ul>
<h2>Behavior</h2>
<ul>
<li><strong>Weekly reset:</strong> Tuesdays <strong>03:00 UTC</strong>. At reset, the bot updates the channel message to indicate its waiting for the new week.</li>
<li><strong>Polling cadence:</strong> adaptive back-off until fresh data is found:
<ul>
<li>Every 5 min for the first hour</li>
<li>Then every 15 min until 3 hours</li>
<li>Then every 30 min until 6 hours</li>
<li>Then every 1 hour until 24 hours</li>
<li>Then every 3 hours</li>
</ul>
</li>
<li><strong>Success:</strong> when new valid data appears, the bot updates the message once and idles until the next weekly reset.</li>
<li><strong>Errors / no update yet:</strong> the message shows a generic notice that its still waiting or that an issue occurred (no external source is mentioned).</li>
</ul>
<h2>Actions</h2>
<ul>
<li><strong>stop</strong> — Pauses all checks. The message remains as-is until you <code>resume</code>.</li>
<li><strong>resume</strong> — Returns to the normal weekly cycle (detect reset, then poll until new data).</li>
<li><strong>start</strong> — Pretends the weekly reset just happened and begins polling now. <em>Owner-only.</em></li>
</ul>
<h2>Channel & config</h2>
<ul>
<li><strong>Target channel:</strong> taken from <code>SHAI_DD_CHANNEL_ID</code> (env). If unset, defaults to <code>1404764793377652807</code>.</li>
<li><strong>Scope:</strong> guild-specific. The message lives in this servers configured channel.</li>
</ul>
<h2>Notes</h2>
<ul>
<li>This command only controls the updater; it does not manually edit the posted message.</li>
<li>On each successful weekly update, the bot compares content against the previous week to avoid duplicate posts.</li>
</ul>