Account Recovery Email Set‐Up

Important

Email recovery configurations are currently only supported on AlixVelocity.

The following setup allows players to link their email addresses for emergency account recovery.

Configuring `email-config.yml`

When you open the configuration file, you will see the following default structure:

username: The login name used for authentication. This is usually identical to your email.
email: The address the message is sent from. This typically matches your username unless your provider supports authorized aliases. In the recipient's inbox, this appears in the From: (...) header.
sender: The display name seen by the receiver (e.g., "MyServer Support").
password: The password used for authentication. Note: This is usually an App Password, not your main email account password (see the setup guide below).
host: The address of the SMTP server relaying your messages.
port: The port dictates your encryption settings. Use 587 for modern STARTTLS (upgrade to encrypted if possible), or 465 for strict, immediate SSL. Any other value enforces strict SSL upon connection and verifies server identity.

This guide demonstrates how to configure the plugin using a personal Gmail account.

Warning

This method is subject to Gmail's 100 requests per rolling 24-hour limit. It is recommended for smaller servers or testing purposes.

1. Access Security Settings
Navigate to your Google Account Settings and select the Security tab.

2. Enable 2-Step Verification
Click on 2-Step Verification and complete the setup process (e.g., via an authenticator app or SMS).

3. Generate an App Password
Return to the main Security page and use the search bar to find App passwords.

4. Name Your App
Choose a recognizable name for the application (e.g., "AlixVelocity") and click Create.

5. Update Your Config
Google will generate a 16-character password. Copy this directly into the password parameter of your email-config.yml.

6. Verify in Console
Start your server. You should see a successful verification message in your console confirming the SMTP connection.