mirror of
https://github.com/DarkflameUniverse/DarkflameServer.git
synced 2026-10-08 13:53:45 +00:00
e213a7aeff
The NexusDashboard-parity dashboard (dDashboardServer) and everything built on it on the experimental branch: accounts, characters, properties and moderation tools, permissions shared with in-game slash commands, economy reports, World 3D and property 3D views with client scenery, scheduled events (features, vanity changes, live events, announcements, restarts), vanity files and events, the CDClient browser, the message inspector with saved captures, chat filter tools, community challenges, live ops, the AI moderator helper, and the server-side changes they need. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
38 lines
1.4 KiB
Python
38 lines
1.4 KiB
Python
"""The adapter interface: everything specific to one chat service lives behind it.
|
|
|
|
To add a service (Matrix, IRC, ...): subclass Adapter, implement run() and send(), and register it in
|
|
adapters/__init__.py. The bridge handles the dashboard, filtering, loop prevention and rate limits.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
from typing import Awaitable, Callable
|
|
|
|
from ..core import GameMessage, RemoteMessage
|
|
|
|
# Given to run(): call it with each message the service receives, to post it in the game
|
|
Deliver = Callable[[RemoteMessage], Awaitable[None]]
|
|
|
|
|
|
class Adapter:
|
|
#: The config key under a link that holds this adapter's settings, e.g. "discord"
|
|
name = "base"
|
|
#: The default label players see ("[Discord] Bob: hi"); a link's "label" overrides it
|
|
default_label = "Bridge"
|
|
|
|
def __init__(self, config: dict):
|
|
self.config = config
|
|
|
|
async def run(self, deliver: Deliver) -> None:
|
|
"""Receive messages from the service for as long as the bridge runs, calling deliver() for each.
|
|
|
|
Ignore messages the adapter itself posted (e.g. Discord bot/webhook messages) so they don't loop back.
|
|
An adapter that only sends can just return.
|
|
"""
|
|
|
|
async def send(self, msg: GameMessage, skipped: int = 0) -> None:
|
|
"""Post one game chat message on the service. `skipped` is how many were dropped by the rate limit before it."""
|
|
raise NotImplementedError
|
|
|
|
async def close(self) -> None:
|
|
pass
|