Discord Integration

Overview

Sakuya AC supports real-time chat synchronization between Discord and your YSFlight server. Players can communicate across platforms, with messages automatically relayed in both directions.

Discord messages appear in-game with the [Discord] prefix, and in-game messages are sent to your configured Discord channel.

Features

Bidirectional messaging - Discord ↔ YSFlight chat sync
Automatic @mention sanitization - Prevents @everyone and @here abuse
Bot message filtering - Ignores messages from other bots
Player join/leave notifications - Discord alerts when players connect/disconnect
Non-blocking operation - Runs asynchronously without impacting server performance

Prerequisites

Python Dependencies

Discord integration requires additional Python packages:

pip install -r requirements.txt

On modern Linux distributions, you may need to create a virtual environment:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Required Dependencies

The integration uses:

aiohttp - Asynchronous HTTP client for Discord API
asyncio - Async runtime (included in Python 3.7+)

Setting Up Discord Bot

Create Discord Application

Go to Discord Developer Portal
Click New Application
Enter a name (e.g., “YSFlight Chat Bot”)
Click Create

Create Bot User

Navigate to the Bot section in the left sidebar
Click Add Bot
Confirm by clicking Yes, do it!
Customize the bot’s username and avatar if desired

Configure Bot Permissions

Enable the Message Content Intent:

Scroll to Privileged Gateway Intents
Enable Message Content Intent
Click Save Changes

Without Message Content Intent, the bot cannot read messages from users.

Get Bot Token

In the Bot section, find the Token area
Click Reset Token (or Copy if visible)
Copy the token and save it securely

Never share your bot token! Treat it like a password. If exposed, reset it immediately in the Developer Portal.

Invite Bot to Server

Go to OAuth2 > URL Generator
Select scopes:
- bot
Select bot permissions:
- Read Messages/View Channels
- Send Messages
- Read Message History
Copy the generated URL and open it in your browser
Select your server and authorize

Get Channel ID

Enable Developer Mode in Discord:
- User Settings > Advanced > Developer Mode
Right-click the channel you want to use
Click Copy Channel ID
Save this ID for configuration

Configuration

Edit your config.py file with the Discord settings:

config.py

# Discord chat integration
DISCORD_ENABLED = True

# Your bot token from the Developer Portal
DISCORD_TOKEN = "MTIzNDU2Nzg5MDEyMzQ1Njc4OQ.GhIjKl.MnOpQrStUvWxYzAbCdEfGhIjKlMnOpQrStUv"

# Channel ID where messages will be synced
CHANNEL_ID = 1234567890123456789

DISCORD_ENABLED

bool

required

Set to True to enable Discord integration, False to disable.

DISCORD_TOKEN

str

required

Your Discord bot token from the Developer Portal.

CHANNEL_ID

int

required

The Discord channel ID where messages will be synchronized.

How It Works

Message Flow

Discord → YSFlight:

[Discord User]: Hello from Discord!

Appears in-game as:

[Discord] Discord User: Hello from Discord!

YSFlight → Discord:

[Sakuya]: Hello from YSFlight!

Sent to Discord as:

Sakuya: Hello from YSFlight!

Player Notifications

When players join or leave, Discord receives notifications:

Sakuya has joined the server!
Sakuya has left the server!

Security Features

@mention Sanitization

The integration automatically removes @everyone and @here mentions from Discord messages before relaying them to the game:

# In discordSync.py
message = re.sub(r'@(?:everyone|here)', '', message)

This prevents Discord users from spamming mass mentions through the game chat.

Bot Message Filtering

Messages from bots (including the integration bot itself) are automatically ignored to prevent message loops:

if author.get('bot'):
    return  # Skip bot messages

Implementation Details

Discord API Communication

The integration uses Discord’s REST API (v10) with the following endpoints: Sending Messages:

POST https://discord.com/api/v10/channels/{channel_id}/messages

Fetching Messages:

GET https://discord.com/api/v10/channels/{channel_id}/messages?limit=1&after={last_message_id}

Polling Mechanism

The system polls Discord every 1 second for new messages:

async def monitor_channel(channel_id, playerList:list):
    last_message_id = None
    while True:
        messages = await discord_fetch_messages(channel_id, last_message_id)
        # Process new messages
        await asyncio.sleep(1)  # Poll every second

This polling interval balances responsiveness with API rate limits. You can adjust it in lib/discordSync.py:98 if needed.

Broadcasting to Players

When a Discord message is received, it’s broadcast to all connected players:

encoded_msg = txtMsgr.encode(f"[Discord] {username}: {content}", True)
for player in playerList:
    player.streamWriterObject.write(encoded_msg)
    await player.streamWriterObject.drain()

Disconnected players are automatically removed from the broadcast list.

Troubleshooting

Bot not receiving messages

Message Content Intent not enabled

Verify in the Developer Portal:

Go to your application
Navigate to Bot
Scroll to Privileged Gateway Intents
Ensure Message Content Intent is enabled
Save changes and restart your server

Incorrect bot token

Check your DISCORD_TOKEN in config.py:

Tokens should be 70+ characters long
They contain letters, numbers, and special characters
If unsure, reset the token in the Developer Portal

Wrong channel ID

Verify your CHANNEL_ID:

Channel IDs are 17-19 digit numbers
Must be an integer, not a string
The bot must have access to this channel

Bot not sending messages

Missing permissions

Ensure the bot has these permissions in the channel:

Read Messages/View Channels
Send Messages
Read Message History

Check channel-specific permissions overrides.

API errors in logs

Check your server logs for Discord API errors:

LOGGING_LEVEL = DEBUG  # In config.py

Common errors:

401 Unauthorized - Invalid token
403 Forbidden - Missing permissions
404 Not Found - Invalid channel ID

Dependencies not installing

Linux virtual environment required

Modern Linux distros require virtual environments:

# Create venv
python3 -m venv venv

# Activate venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows

# Install dependencies
pip install -r requirements.txt

# Run server (keep venv activated)
python main.py

Python version too old

The integration requires Python 3.7+ for asyncio support:

python --version

If you have an older version, upgrade Python before installing dependencies.

Performance Considerations

Asynchronous operation: Discord integration runs in the background without blocking game packets
Connection pooling: Uses aiohttp session pooling for efficient API requests
Player cleanup: Disconnected players are automatically removed from broadcast lists
Rate limiting: 1-second polling interval respects Discord’s rate limits

Security Best Practices

Protect Your Token

Never commit DISCORD_TOKEN to version control. Use environment variables or a separate credentials file that’s gitignored.

Limit Bot Permissions

Only grant the minimum required permissions. The bot doesn’t need administrator rights.

Monitor API Usage

Discord has rate limits. If you experience issues, check the polling interval in discordSync.py.

Use Read-Only Roles

Consider creating a read-only role for the bot in sensitive channels to prevent accidental message sends.

Advanced Configuration

Custom Message Formatting

To customize how Discord messages appear in-game, edit lib/discordSync.py:84:

# Default format
encoded_msg = txtMsgr.encode(f"[Discord] {username}: {content}", True)

# Custom format
encoded_msg = txtMsgr.encode(f"💬 {username} from Discord: {content}", True)

Adjust Polling Rate

To change how often Discord is checked for new messages, modify lib/discordSync.py:98:

await asyncio.sleep(1)  # Default: 1 second
await asyncio.sleep(0.5)  # Faster: 0.5 seconds (higher API usage)
await asyncio.sleep(2)  # Slower: 2 seconds (lower API usage)

Faster polling increases API requests. Discord may rate limit your bot if you poll too frequently.

Get Started

Core Concepts

Configuration

Features

Discord Integration

Overview

Features

Prerequisites

Python Dependencies

Required Dependencies

Setting Up Discord Bot

Configuration

How It Works

Message Flow

Player Notifications

Security Features

Implementation Details

Discord API Communication

Polling Mechanism

Broadcasting to Players

Troubleshooting

Bot not receiving messages

Bot not sending messages

Dependencies not installing

Performance Considerations

Security Best Practices

Protect Your Token

Limit Bot Permissions

Monitor API Usage

Use Read-Only Roles

Advanced Configuration

Custom Message Formatting

Adjust Polling Rate

Build docs developers (and LLMs) love

Get Started

Core Concepts

Configuration

Features

​Overview

​Features

​Prerequisites

​Python Dependencies

​Required Dependencies

​Setting Up Discord Bot

​Configuration

​How It Works

​Message Flow

​Player Notifications

​Security Features

​Implementation Details

​Discord API Communication

​Polling Mechanism

​Broadcasting to Players

​Troubleshooting

​Bot not receiving messages

​Bot not sending messages

​Dependencies not installing

​Performance Considerations

​Security Best Practices

Protect Your Token

Limit Bot Permissions

Monitor API Usage

Use Read-Only Roles

​Advanced Configuration

​Custom Message Formatting

​Adjust Polling Rate

Build docs developers (and LLMs) love

Overview

Features

Prerequisites

Python Dependencies

Required Dependencies

Setting Up Discord Bot

Configuration

How It Works

Message Flow

Player Notifications

Security Features

Implementation Details

Discord API Communication

Polling Mechanism

Broadcasting to Players

Troubleshooting

Bot not receiving messages

Bot not sending messages

Dependencies not installing

Performance Considerations

Security Best Practices

Advanced Configuration

Custom Message Formatting

Adjust Polling Rate