PolyhydraGames.Discord 1.0.8

PolyhydraGames.Discord

Discord bot integration library for PolyhydraGames and ChannelCheevos. Provides a Discord.Net-based client for real-time chat monitoring, slash commands, and role synchronization.

Documentation

• Docs Index
• Feature Index
• Roadmap Index
• POC

Tags

• dotnet
• api
• api-discord
• auth
• discord
• chat

Features

• Discord Bot Client - Connect as a bot, monitor channels, send messages
• Slash Commands - Register and handle /cheevos, /score, /link commands
• Role Synchronization - Auto-assign Discord roles when users unlock achievements
• Webhook Messenger - Simple outbound messaging via Discord webhooks
• Account Linking - Link Discord accounts to ChannelCheevos accounts

Installation

dotnet add package PolyhydraGames.Discord

Configuration

Add to your appsettings.json:

{
  "Discord": {
    "Enabled": true,
    "BotKey": "your-discord-bot-token",
    "ChannelMonitor": "bot-commands",
    "OwnerUserId": "1234567890",
    "GuildId": "987654321098765432",
    "CheevoRoles": "first-blood:111222333444555666,gold-winner:777888999000111222",
    "DefaultCheevoRole": "123456789012345678",
    "OutboundWebhookEnabled": true,
    "OutboundWebhookUrl": "https://discord.com/api/webhooks/...",
    "Admins": "admin1,admin2"
  }
}

Configuration Options

Usage

Basic Bot Setup

using PolyhydraGames.Discord.Extensions;
using PolyhydraGames.Discord.Services;

// In Program.cs or Startup.cs
services.AddDiscordBot(Configuration);

// Resolve and start the bot
var bot = serviceProvider.GetRequiredService<DiscordBot>();
await bot.Start();

Slash Commands & Role Sync

using PolyhydraGames.Discord.Extensions;
using PolyhydraGames.Discord.Interfaces;

// Add with external service integration
services.AddDiscordCheevoService(
    Configuration,
    sp => userId => cheevoService.GetCheevosDisplayAsync(userId),
    sp => userId => cheevoService.GetScoreDisplayAsync(userId),
    sp => (userId, cheevoKey, guildId) => roleService.SyncRoleAsync(userId, cheevoKey, guildId),
    sp => (userId, username, token) => accountService.LinkAccountAsync(userId, username, token)
);

// The DiscordCheevoService will automatically:
// 1. Register slash commands on bot ready
// 2. Handle /cheevos, /score, /link commands
// 3. Sync roles when cheevos are unlocked

Webhook Messaging

For simple outbound notifications without a full bot:

using PolyhydraGames.Discord.Extensions;
using PolyhydraGames.Discord.Interfaces;

services.AddDiscordWebhookMessenger(Configuration);

// Inject and use
public class MyService
{
    private readonly IDiscordWebhookMessenger _messenger;
    
    public MyService(IDiscordWebhookMessenger messenger)
    {
        _messenger = messenger;
    }
    
    public async Task NotifyAsync(string message)
    {
        await _messenger.SendAsync(message);
    }
}

Main Types

Slash Commands

When using DiscordCheevoService, the following commands are registered:

Architecture

┌─────────────────────────────────────────────────────────────┐
│                    Your Application                          │
├─────────────────────────────────────────────────────────────┤
│  IDiscordCheevoService    │    IDiscordWebhookMessenger     │
│  (slash commands, roles)  │    (outbound messages)          │
├───────────────────────────┴─────────────────────────────────┤
│                     DiscordBot                               │
│              (DiscordSocketClient wrapper)                   │
├─────────────────────────────────────────────────────────────┤
│                    Discord.Net                               │
└─────────────────────────────────────────────────────────────┘

Related Projects

• ChannelCheevos - Main streaming achievement platform
• PolyhydraGames.OAuth.Core - OAuth and command queue infrastructure
• PolyhydraGames.Streaming.Interfaces - Platform abstraction interfaces

Repository

• GitHub: https://github.com/lancer1977/Api.Discord
• Issues: https://github.com/lancer1977/Api.Discord/issues

Publishing

Use ./pub.sh to restore, test, pack, and publish.

• GitHub Packages is the default publish target.
• Set PUBLISH_NUGET_ORG=true only when the package should also go to nuget.org.
• Set DRY_RUN=true to skip pushes.
• Use PACKAGE_API_KEY, GHCR_TOKEN, GITHUB_PACKAGES_TOKEN, GITHUB_TOKEN, or GH_TOKEN for GitHub Packages auth.

For private/internal consumption from GitHub Packages, add the GitHub NuGet source for this organization and authenticate with a GitHub token or PAT:

dotnet nuget add source https://nuget.pkg.github.com/lancer1977/index.json \
  --name lancer1977 \
  --username YOUR_GITHUB_USERNAME \
  --password YOUR_GITHUB_TOKEN \
  --store-password-in-clear-text

License

MIT License - see LICENSE for details.