wsnAuth

> **日本語は下に。プラグインは日本語のみ。** > **Japanese description is available below. The plugin itself is available in Japanese only.** # wsnAuth wsnAuth is a Velocity plugin that links Minecraft accounts with Discord accounts and allows only verified players to join your network. When an unverified player connects, they receive a six-digit verification code on the Minecraft disconnect screen. They can link their account by pressing the verification button in Discord and entering the code in the displayed form. ## Features - Minecraft and Discord account verification using a six-digit one-time code - Discord server membership checks on every verified login - Automatic assignment and removal of a verified Discord role - Discord role synchronization with LuckPerms groups - Live Discord server-status panel for all backend servers registered in Velocity - PremiumVanish support for hiding vanished players from the status panel - Configurable limit on the number of Minecraft accounts linked to one Discord account - Protection against repeated invalid-code submissions - Customizable Minecraft and Discord messages through `messages.yml` - Persistent account links stored in JSON ## Requirements - Java 17 or newer - Velocity 3.4.x - A Discord Bot - LuckPerms 5.4 or newer — optional, required only for role synchronization - PremiumVanish — optional, used only to hide vanished players from the status panel Velocity must use `online-mode=true`. Offline UUID configurations cannot securely preserve account ownership. ## Installation 1. Download the plugin JAR. 2. Place it in the Velocity `plugins` directory. 3. Start Velocity once to generate the configuration files. 4. Stop Velocity and edit `plugins/wsnauth/config.yml`. 5. Start Velocity again. The plugin will fail to connect to Discord on the first startup while the default Bot Token is still configured. This is expected; edit the generated configuration before starting Velocity again. ## Discord Bot setup Create a Bot in the (https://discord.com/developers/applications), then: 1. Enable **Server Members Intent** in the Bot settings. 2. Invite the Bot to the Discord server used for verification. 3. Grant the Bot the following permissions: - View Channels - Send Messages - Read Message History - Embed Links — required for the server-status panel - Manage Roles — required for the verified-role feature 4. When using automatic role assignment, place the Bot's role above the role it needs to manage. ## Configuration example ```yaml discord: token: "YOUR_BOT_TOKEN_HERE" guildId: 123456789012345678 adminId: 0 verificationChannelId: 123456789012345678 verifiedRoleId: 123456789012345678 serverStatusChannelId: 123456789012345678 inviteUrl: "https://discord.gg/your-invite" security: maxFailures: 3 blockMinutes: 5 maxAccountsPerUser: 1 debug: false role-sync: - roleId: 111111111111111111 group: "member" - roleId: 222222222222222222 group: "vip" ``` Set an optional Discord feature ID to `0` to disable that feature. If LuckPerms role synchronization is not needed, use `role-sync: `. The status channel can also be configured with the `SERVER_STATUS_CHANNEL_ID` environment variable. The environment variable takes priority over `config.yml`. ## Verification flow 1. Connect to the Minecraft server. 2. Copy the six-digit code displayed on the disconnect screen. 3. Join the configured Discord server. 4. Press **認証を開始** in the verification channel. 5. Enter the code in the displayed form. 6. Reconnect to the Minecraft server after verification succeeds. Verification codes expire after five minutes and can only be submitted once. Reconnect to the Minecraft server to receive a new code if the previous code expires or is consumed. ## Commands | Command | Permission | Description | | --- | --- | --- | | `/unlink` | None | Unlinks your Minecraft account from Discord | | `/discord <player>` | `discordauth.admin` | Displays the player's linked Discord username, ID, and verification date | ## LuckPerms synchronization Each entry under `role-sync` maps a Discord role to a LuckPerms group. Synchronization runs when: - A mapped Discord role is added or removed - A verified player connects to Minecraft - Minecraft and Discord verification is completed The LuckPerms group is granted while the Discord member has at least one role mapped to that group, and removed when they have none. Account verification continues to work normally when LuckPerms is not installed; only role synchronization is disabled. ## Server-status panel When `serverStatusChannelId` is configured, wsnAuth publishes one Discord Embed containing: - The online or offline state of every backend server registered in Velocity - Visible player names and player counts - The number of currently available backend servers - An offline status when the Velocity proxy shuts down The status is checked every five seconds, and the Discord message is updat