Setup checklist

Setup checklist

Everything behind the README's Quick start, for reference. Optional items can be skipped.

Discord

• Bot created and invited with the Quick start link (it includes every permission Nyerk needs)
• Timer, roles, logs and party finder channels; timer read-only for members, party finder open for chat (Nyerk deletes members' messages after 15 minutes). Or let Nyerk make them: Settings → Create all missing channels
• Ping roles for the events you want, each mentionable
• Tank, Support and DPS roles (party finder); class roles too, or create them later on the web page
• Nyerk's role above every role it hands out
• Manage Messages for Nyerk in the party finder channel, so it can delete old chat
• Optional: Manage Messages for Nyerk in the roles channel, so Remove all my ping roles also clears members' reactions

Server

• DISCORD_TOKEN, GUILD_ID and ADMIN_PASSWORD in .env (or Dockge's env box)
• Optional: WEB_TLS=off behind your own HTTPS reverse proxy; PUID/PGID if the data folder must belong to a specific host user

Web page

• Settings: the four channel IDs (or Create channel); server time zone (default America/New_York)
• Roles: a role ID for each event category, then Post roles channel
• Party finder: class role IDs (or Create missing roles) and Tank/Support/DPS role IDs, content with minimum gear score, dungeon roles (paste IDs or Create missing roles), then Post all panels
• Events / Maintenance: check boss respawn times, which alerts send and ping, and the weekly maintenance window (switch the Maintenance event off to stop its own alerts; nothing else is sent during it either way)
• Optional: the shugo.gg suggestions on Defaults (Artifact Siege, Siege Bosses, Nahma, Watcher Kaira), message wording, dashboard headings, party timings, gear score options
• Optional: import a settings file instead of typing IDs (Settings → Export and import)
• Optional: share another server's party finder (Games → Party finders shared with other servers, see Games)

On first start Nyerk already has the ten launch events, six ping categories, eight classes, the gear score options and availability windows. No channel or role IDs are built in; you add your own.