Getting Started

Overview

mineLogin is a feature-rich authentication plugin for BungeeCord and Velocity proxy servers. It provides a complete login system supporting both cracked and premium (paid) accounts, two-factor authentication, email-based account recovery, and captcha verification.

Features

• Dual Proxy Support — works on both BungeeCord and Velocity
• Premium Account Detection — automatic login for verified Mojang/Microsoft accounts
• Cracked Account Support — password-based registration and login
• Two-Factor Authentication — TOTP-based 2FA with recovery codes
• Email Recovery — SMTP-based account recovery with configurable templates
• Captcha Verification — chat-based or map-based captcha during registration
• Session System — IP-based trusted sessions to skip password entry
• Bridge Plugin — Spigot/Paper plugin for login location, player restrictions, and map captcha
• Multiple Databases — H2, MySQL, or MongoDB backends (MongoDB recommended)
• Proxy-Backend Communication — Redis or NATS for proxy-to-backend synchronization
• Password Security — BCrypt, Argon2, SHA-512, SHA-256, or MD5 hashing
• Brute Force Protection — login attempt limits with automatic IP banning
• Bedrock Support — Geyser/Floodgate integration for Bedrock players
• PlaceholderAPI — display account data anywhere on backend servers
• Boss Bar & Titles — visual login/register prompts
• Developer API — public interfaces and events for external plugin integration

Requirements

• Java 21+
• BungeeCord or Velocity proxy

Optional

• Spigot/Paper 1.8+ (for the bridge plugin)
• PlaceholderAPI (for placeholders on backend servers)
• Floodgate (for Bedrock player support)
• Redis or NATS (recommended for proxy-backend communication)
• MySQL (alternative database backend)

Installation

Proxy (BungeeCord / Velocity)

1. Download the latest mineLogin-*-bungeecord.jar or mineLogin-*-velocity.jar
2. Place it in your proxy’s plugins/ folder
3. Start or restart the proxy
4. Stop the server
5. Open plugins/mineLogin/configuration.yml and set your license key:

   license-key: YOUR_LICENSE_KEY_HERE

6. Configure your login servers and save the file
7. Start the server

Bridge (Spigot / Paper)

1. Download the latest mineLogin-*-bridge.jar
2. Place it in your backend server’s plugins/ folder
3. Start or restart the server
4. Edit the bridge configuration in plugins/mineLogin-Bridge/

Configuration Files

After first startup, the following files are generated in plugins/mineLogin/:

File	Description
configuration.yml	Main plugin configuration (database, security, servers, premium, 2FA, etc.)
messages.yml	All plugin messages with legacy color code formatting
blocked-passwords.yml	List of forbidden passwords
commands.yml	Command names, aliases, permissions, and toggle settings

The bridge plugin generates its own configuration in plugins/mineLogin-Bridge/:

File	Description
configuration.yml	Bridge settings (communication, login location, player restrictions)

Quick Setup

Minimal (H2)

No additional configuration is required. The plugin uses an embedded H2 database by default.

Recommended (MongoDB + Redis)

database:
  data-type: MONGODB
  mongo-db-connection-string: "mongodb://localhost:27017"
  base: "mineLogin"

communication:
  type: REDIS
  host: "localhost"
  port: 6379
  password: "securepass"

Server Configuration

Define your login and lobby servers:

servers:
  login-servers:
    - "auth-1"
    - "auth-2"
  fallback-server: true
  change-server-after-login: false
  after-login-servers:
    - "lobby-1"
    - "lobby-2"