nLogin

https://docs.nickuc.com/nlogin/
Admin
nLogin is a secure authentication and login management system that offers premium features, proxy...
Tokens:10,584
Snippets:95
Trust Score:6.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure nLogin database settings

Source: https://docs.nickuc.com/nlogin/config/storage

Example configuration block for the nLogin config.yml file to connect to a remote database.

```yaml
#      ___      _        _  
#     /   \__ _| |_ __ _| |__   __ _ ___  ___  
#    / /\ / _` | __/ _` | '_ \ / _` / __|/ _ \  
#   / /_// (_| | || (_| | |_) | (_| \__ \  __/  
#  /___,' \__,_|\__\__,_|_.__/ \__,_|___/\___|  
  
# Database settings.  
database:  
  # Sets the type of database used.  
  #  
  # - Options available:  
  #  |=> MariaDB  
  #  |=> MySQL  
  #  |=> SQLite  
  type: MariaDB  
  
  remote:  
    # Defines MariaDB/MySQL information.  
    # - Tutorial for installation: https://docs.nickuc.com/nlogin/mysql  
    hostname: "localhost:3306"  
    database: "nlogin"  
    username: "root"  
    password: ""  
  
    # Set the connection properties.  
    # - Don't change this information if you don't know what you are doing!  
    properties:  
      #useSSL: false  
      #sslMode: disable  
      #verifyServerCertificate: false  
      useUnicode: true  
      characterEncoding: "utf8"
```

--------------------------------

### Configure Backend Authentication Servers

Source: https://docs.nickuc.com/nlogin/proxy

Define the list of servers where nLogin is installed to handle authentication. Ensure check-ack-message is disabled if using non-Spigot based servers.

```yaml
#     ___            _                  _  
#    / __\ __ _  ___| | _____ _ __   __| |  
#   /__\/// _` |/ __| |/ / _ \ '_ \ / _` |  
#  / \/  \ (_| | (__|   <  __/ | | | (_| |  
#  \_____/\__,_|\___|_|\_\___|_| |_|\__,_|  
  
# Settings related to the backend servers.  
backend:  
  # Sets the list of authentication servers.  
  # - You must enter this list ALL servers that nLogin is installed on.  
  # - Most servers use either an authentication server or a main lobby.  
  # - For more information, go to the tutorial:  
  #  ==> https://docs.nickuc.com/nlogin/proxy  
  auth-servers:  
    - 'lobby'  
  
  # Defines whether the proxy should check if authentication servers are properly configured.  
  # - If you are using a server without nLogin (e.g. limbo servers not based on Spigot)  
  #   it is recommended to disable this option.  
  check-ack-message: true  
```

--------------------------------

### Initialize MySQL session and database

Source: https://docs.nickuc.com/nlogin/config/storage

Commands to set the storage engine and create a database with appropriate character sets for different MySQL versions.

```sql
SET storage_engine=InnoDB
```

```sql
CREATE DATABASE <database name> CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci
```

```sql
CREATE DATABASE <database name> CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci
```

--------------------------------

### Configure Backend Acknowledgement

Source: https://docs.nickuc.com/nlogin/config/template

Toggle the proxy check for authentication server configuration.

```yaml
# Defines whether the proxy should check if authentication servers are properly configured.  
check-ack-message: true
```

--------------------------------

### Main Configuration Template

Source: https://docs.nickuc.com/nlogin/config/template

The primary configuration file for nLogin. Defines language settings, database type, and connection pool parameters.

```yaml
####################################################################################################  
# +----------------------------------------------------------------------------------------------+ #  
# |                                          __             _                                    | #  
# |                                 _ __   / /  ___   __ _(_)_ __                                | #  
# |                                | '_ \ / /  / _ \ / _` | | '_ \                               | #  
# |                                | | | / /__| (_) | (_| | | | | |                              | #  
# |                                |_| |_\____/\___/ \__, |_|_| |_|                              | #  
# |                                                    |___/                                     | #  
# |                                                                                              | #  
# |                      A practical, secure and friendly authentication plugin                  | #  
# |                                                                                              | #  
# |                                © 2024 - Powered by nickuc.com                                | #  
# |                                                                                              | #  
# |                                                                                              | #  
# |  For a better understanding of this file see our documentation:                              | #  
# |   ==> https://docs.nickuc.com/nlogin/                                                        | #  
# |                                                                                              | #  
# |  New options are not automatically added in this file. Default values are used               | #  
# |  if an option is not found.                                                                  | #  
# +----------------------------------------------------------------------------------------------+ #  
####################################################################################################  
  
# Set the version of the file.  
language-version: 2  
  
# Sets the debugging mode.  
# - This option is used to find problems in the plugin.  
debug: false  
  
# Set the language of the plugin  
#  
# - Available translations:  
#  
#  |=> Arabic: messages_ar.yml  
#  |=> Bulgarian: messages_bg.yml  
#  |=> Chinese: messages_cn.yml  
#  |=> Czech: messages_cz.yml  
#  |=> German: messages_de.yml  
#  |=> English: messages_en.yml  
#  |=> Spanish: messages_es.yml  
#  |=> French: messages_fr.yml  
#  |=> Hungarian: messages_hu.yml  
#  |=> Indonesian: messages_id.yml  
#  |=> Italian: messages_it.yml  
#  |=> Lithuanian: messages_lt.yml  
#  |=> Polish: messages_pl.yml  
#  |=> Portuguese: messages_br.yml  
#  |=> Romanian: messages_ro.yml  
#  |=> Russian: messages_ru.yml  
#  |=> Turkish: messages_tr.yml  
#  |=> Ukrainian: messages_ua.yml  
#  |=> Vietnamese: messages_vn.yml  
#  |=> Other languages: https://github.com/nickuc/OpeNLogin/blob/master/docs/lang.md  
#  
# - When changing the language, the current file can be reset.  
language-file: "messages_en.yml"  
  
#      ___      _        _  
#     /   \__ _| |_ __ _| |__   __ _ ___  ___  
#    / /\ / _` | __/ _` | '_ \ / _` / __|/ _ \  
#   / /_// (_| | || (_| | |_) | (_| \__ \  __/  
#  /___,' \__,_|\__\__,_|_.__/ \__,_|___/\___|  
  
# Database settings.  
database:  
  # Sets the type of database used.  
  #  
  # - Options available:  
  #  |=> MariaDB  
  #  |=> MySQL  
  #  |=> SQLite  
  type: SQLite  
  
  remote:  
    # Defines MariaDB/MySQL information.  
    # - Tutorial for installation: https://docs.nickuc.com/nlogin/mysql  
    hostname: "localhost:3306"  
    database: "nLogin"  
    username: "root"  
    password: ""  
  
    # Set the connection properties.  
    # - Don't change this information if you don't know what you are doing!  
    properties:  
      #useSSL: false  
      #sslMode: disable  
      #verifyServerCertificate: false  
      useUnicode: true  
      characterEncoding: "utf8"  
  
  # Defines the connection pool settings.  
  # - Don't change this information if you don't know what you are doing!  
  pool-settings:  
    maximum-pool-size: 10  
    minimum-idle: 10  
    maximum-lifetime: 1800000 # 30 minutes  
    connection-timeout: 5000 # 5 seconds  
  
  table:  
    account:  
      # Sets the name of the nLogin accounts table.  
```

--------------------------------

### Configure Premium and Session Settings

Source: https://docs.nickuc.com/nlogin/config/template

Settings for automatic premium authentication and login session persistence.

```yaml
premium:  
  # Defines whether premium players should authenticate automatically.  
  # - You can change this setting freely: already registered users  
  #   will NOT be vulnerable by this change  
  enable: true  

  # Defines whether premium players should skip registration.  
  # - It is recommended to disable this option if you use player passwords  
  #   in a web integration (e.g. server site).  
  skip-register: true  

session:  
  # Defines whether login sessions will be used.  
  # - Authentication will be ignored if the player logs in at the timeout  
  #   and continues using the same IP address.  
  enable: true  

  # Sets the duration (in minutes) of login sessions.  
  # => Very long session times may open vulnerabilities if the player's IP  
  #    is public (proxies, public VPNs, shared networks)  
  #    or if it switches too quickly (on ISPs with dynamic IP).  
  #  
  # - To make a session permanent use the value 0. However, this is inadvisable.  
  duration: 5
```

--------------------------------

### Configure allowed authentication tokens

Source: https://docs.nickuc.com/nlogin/proxy/bungeeguard

Add the proxy-generated tokens to the backend server's configuration file to authorize connections.

```yaml
# Allowed authentication tokens.  
allowed-tokens:  
- "YOUR TOKEN HERE"  

```

--------------------------------

### Configure Post-Authentication Redirection

Source: https://docs.nickuc.com/nlogin/proxy

Set up server redirection rules to forward players to specific lobbies after they successfully authenticate.

```yaml
#     ___            _                  _  
#    / __\ __ _  ___| | _____ _ __   __| |  
#   /__\/// _` |/ __| |/ / _ \ '_ \ / _` |  
#  / \/  \ (_| | (__|   <  __/ | | | (_| |  
#  \_____/\__,_|\___|_|\_\___|_| |_|\__,_|  
  
# Settings related to the backend servers.  
backend:  
  # Sets the list of authentication servers.  
  # - You must enter this list ALL servers that nLogin is installed on.  
  # - Most servers use either an authentication server or a main lobby.  
  # - For more information, go to the tutorial:  
  #  ==> https://docs.nickuc.com/nlogin/proxy  
  auth-servers:  
    - 'auth'  
  
  # Defines whether the proxy should check if authentication servers are properly configured.  
  # - If you are using a server without nLogin (e.g. limbo servers not based on Spigot)  
  #   it is recommended to disable this option.  
  check-ack-message: true  
  
#     __          _ _               _  
#    /__\ ___  __| (_)_ __ ___  ___| |_  
#   / \/// _ \/ _` | | '__/ _ \/ __| __|  
#  / _  \  __/ (_| | | | |  __/ (__| |_  
#  \/ \_/\___|\__,_|_|_|  \___|\___|\__|  
  
# Server redirection settings.  
redirect:  
  # Defines whether the redirection of the first server should be overwritten by nLogin.  
  # - This option prevents players from bypassing the authentication server  
  #   and restores the first server provided by the proxy.  
  override-first-server: true  
  
  # Defines whether the plugin should redirect players to the last connected server.  
  # - If the last connected server no longer exists, a random server from the "after-auth.servers" option will be chosen.  
  redirect-to-last-server: false  
  
  # Sets the waiting time (in milliseconds) when switching the server.  
  connect-delay: 500  
  
  # Sets the waiting time (in milliseconds) to reconnect to the server when the connection fails.  
  retry-delay: 5000  
  
  after-auth:  
    # Defines whether players should be automatically forwarded to other servers after authentication.  
    enabled: false  
  
    # Defines which servers the players should be forwarded to.  
    # - When entering more than one item, the server will be chosen randomly.  
    servers:  
      - "lobby-1"  
      - "lobby-2"  
```

--------------------------------

### Configure nLogin Proxy Settings

Source: https://docs.nickuc.com/nlogin/config/template

Complete configuration template for nLogin proxy, including backend server lists and redirection rules.

```yaml
####################################################################################################  
# +----------------------------------------------------------------------------------------------+ #  
# |                                          __             _                                    | #  
# |                                 _ __   / /  ___   __ _(_)_ __                                | #  
# |                                | '_ \ / /  / _ \ / _` | | '_ \                               | #  
# |                                | | | / /__| (_) | (_| | | | | |                              | #  
# |                                |_| |\____/\___/ \__, |_|_| |_|                              | #  
# |                                                    |___/                                     | #  
# |                                                                                              | #  
# |                      A practical, secure and friendly authentication plugin                  | #  
# |                                                                                              | #  
# |                                © 2024 - Powered by nickuc.com                                | #  
# |                                                                                              | #  
# |                                                                                              | #  
# |  For a better understanding of this file see our documentation:                              | #  
# |   ==> https://docs.nickuc.com/nlogin/                                                        | #  
# |                                                                                              | #  
# |  New options are not automatically added in this file. Default values are used               | #  
# |  if an option is not found.                                                                  | #  
# +----------------------------------------------------------------------------------------------+ #  
####################################################################################################  
  
# Set the version of the file.  
language-version: 2  
  
#     ___            _                  _  
#    / __\ __ _  ___| | _____ _ __   __| |  
#   /__\/// _` |/ __| |/ / _ \ '_ \ / _` |  
#  / \/  \ (_| | (__|   <  __/ | | | (_| |  
#  \_____/\__,_|\___|_|\_\___|_| |_|\__,_|  
  
# Settings related to the backend servers.  
backend:  
  # Sets the list of authentication servers.  
  # - You must enter this list ALL servers that nLogin is installed on.  
  # - Most servers use either an authentication server or a main lobby.  
  # - For more information, go to the tutorial:  
  #  ==> https://docs.nickuc.com/nlogin/proxy  
  auth-servers:  
    - 'lobby'  
  
  # Defines whether the proxy should check if authentication servers are properly configured.  
  # - If you are using a server without nLogin (e.g. limbo servers not based on Spigot)  
  #   it is recommended to disable this option.  
  check-ack-message: true  
  
#     __          _ _               _  
#    /__\ ___  __| (_)_ __ ___  ___| |_  
#   / \/// _ \/ _` | | '__/ _ \/ __| __|  
#  / _  \  __/ (_| | | | |  __/ (__| |_  
#  \/ \_/\___|\__,_|_|_|  \___|\___|\__|  
  
# Server redirection settings.  
redirect:  
  # Defines whether the redirection of the first server should be overwritten by nLogin.  
  # - This option prevents players from bypassing the authentication server  
  #   and restores the first server provided by the proxy.  
  override-first-server: true  
  
  # Sets the waiting time (in milliseconds) when switching the server.  
  connect-delay: 500  
  
  # Sets the waiting time (in milliseconds) to reconnect to the server when the connection fails.  
  retry-delay: 5000  
  
  last-server:  
    # Defines whether the plugin should redirect players to the last connected server.  
    # - If the last connected server no longer exists, a random server from the "after-auth.servers" option will be chosen.  
    enable: false  
  
    # Defines which servers will be ignored by the redirection.  
    ignored: []  
  
  after-auth:  
    # Defines whether players should be automatically forwarded to other servers after authentication.  
    enable: false  
  
    # Defines which servers the players should be forwarded to.  
    # - When entering more than one item, the server will be chosen randomly.  
    servers:  
      - "lobby1"  
      - "lobby2"
```

--------------------------------

### Add nLogin API via Gradle

Source: https://docs.nickuc.com/nlogin/development/usage

Configure the repository and dependency in your build.gradle file to include the nLogin API.

```groovy
repositories {  
    maven {   
        url = uri('https://repo.nickuc.com/maven-releases/')   
    }  
}  
  
dependencies {  
    compileOnly('com.nickuc.login:api:10.4')  
}
```

--------------------------------

### nLogin Email Configuration Template

Source: https://docs.nickuc.com/nlogin/config/template

The YAML configuration structure for setting up SMTP credentials and email-related account options.

```yaml
####################################################################################################  
# +----------------------------------------------------------------------------------------------+ #  
# |                                          __             _                                    | #  
# |                                 _ __   / /  ___   __ _(_)_ __                                | #  
# |                                | '_ \ / /  / _ \ / _` | | '_ \                               | #  
# |                                | | | / /__| (_) | (_| | | | | |                              | #  
# |                                |_| |_\____/\___/ \__, |_|_| |_|                              | #  
# |                                                    |___/                                     | #  
# |                                                                                              | #  
# |                      A practical, secure and friendly authentication plugin                  | #  
# |                                                                                              | #  
# |                                © 2024 - Powered by nickuc.com                                | #  
# |                                                                                              | #  
# |                                                                                              | #  
# |  For a better understanding of this file see our documentation:                              | #  
# |   ==> https://docs.nickuc.com/nlogin/                                                        | #  
# |                                                                                              | #  
# |  New options are not automatically added in this file. Default values are used               | #  
# |  if an option is not found.                                                                  | #  
# +----------------------------------------------------------------------------------------------+ #  
####################################################################################################  
  
# Set the version of the file.  
language-version: 2  
  
# Defines whether the email can be used as a second factor.  
enable: false  
  
authentication:  
  # Email  
  email: "yourserver@domain.com"  
  # User  
  user: ""  
  # Password  
  password: ""  
  
  # Charset  
  charset: "UTF-8"  
  # Mimetype  
  mimetype: "text/html"  
  
  # SMTP host  
  host: "smtp.gmail.com"  
  # SMTP port  
  port: 587  
  
  # Encryption  
  #  
  # - Options available:  
  #  |=> AUTO  
  #  |=> TLS  
  #  |=> SSL  
  encryption: auto  
  
  # Debug mode  
  debug: false  
  
options:  
  link-required:  
    # Sets whether linking an email will be required to authenticate.  
    enable: false  
  
    # Sets whether premium players will also need to link an email to authenticate themselves.  
    required-for-premium: true  
  
  # Sets the maximum number of accounts that can have the same email linked.  
  account-limit: 1  
  
  # Defines whether the link should be recommended to players.  
  recommend-linking: true  
  
  # Defines whether a new password should be created after the account recovery process.  
  # - If this option is disabled, a random password will be set.  
  force-password-update: false  
  
  # Defines the list of allowed domains.  
  # - If no domain is defined, all domains will be allowed.  
  allowed-domains: []  
  
  # Defines the list of denied domains.  
  denied-domains: []
```

--------------------------------

### Add nLogin API via Maven

Source: https://docs.nickuc.com/nlogin/development/usage

Include the repository and dependency blocks in your pom.xml file to access the nLogin API.

```xml
<repositories>  
  <repository>  
  <id>nickuc-repo</id>  
  <url>https://repo.nickuc.com/maven-releases/</url>  
  </repository>  
</repositories>  
  
<dependencies>  
  <dependency>  
  <groupId>com.nickuc.login</groupId>  
  <artifactId>api</artifactId>  
  <version>10.4</version>  
  <scope>provided</scope>  
  </dependency>  
  <dependency>  
  <groupId>com.nickuc.login</groupId>  
  <artifactId>api</artifactId>  
  <version>10.4</version>  
  <scope>javadocs</scope>  
  </dependency>  
</dependencies>
```

--------------------------------

### Join Configuration

Source: https://docs.nickuc.com/nlogin/config/template

Manages chat cleanup and join message visibility upon player connection.

```yaml
join:  
  # Sets whether the chat should be cleaned upon joining the server.  
  clean-chat-on-join: true  
  
  # Sets whether the join message will be removed.  
  remove-join-message: true
```

--------------------------------

### Discord Configuration Template

Source: https://docs.nickuc.com/nlogin/config/template

The primary configuration file for enabling and customizing Discord integration features.

```yaml
####################################################################################################  
# +----------------------------------------------------------------------------------------------+ #  
# |                                          __             _                                    | #  
# |                                 _ __   / /  ___   __ _(_)_ __                                | #  
# |                                | '_ \ / /  / _ \ / _` | | '_ \                               | #  
# |                                | | | / /__| (_) | (_| | | | | |                              | #  
# |                                |_| |_\____/\___/ \__, |_|_| |_|                              | #  
# |                                                    |___/                                     | #  
# |                                                                                              | #  
# |                      A practical, secure and friendly authentication plugin                  | #  
# |                                                                                              | #  
# |                                © 2024 - Powered by nickuc.com                                | #  
# |                                                                                              | #  
# |                                                                                              | #  
# |  For a better understanding of this file see our documentation:                              | #  
# |   ==> https://docs.nickuc.com/nlogin/                                                        | #  
# |                                                                                              | #  
# |  New options are not automatically added in this file. Default values are used               | #  
# |  if an option is not found.                                                                  | #  
# +----------------------------------------------------------------------------------------------+ #  
####################################################################################################  
  
# Set the version of the file.  
language-version: 2  
  
# Defines whether Discord can be used as a second factor.  
enable: false  
  
authentication:  
  # Defines the token used in the Discord API.  
  #  
  # - For more information, please access the documentation:  
  #    * https://docs.nickuc.com/nlogin/discord  
  #  
  token: ""  
  
options:  
  link-required:  
    # Sets whether linking a Discord account will be required to authenticate.  
    enable: false  
  
    # Sets whether premium players will also need to link a Discord account to authenticate.  
    required-for-premium: true  
  
  # Sets the maximum number of accounts that can have the same Discord linked.  
  account-limit: 1  
  
  # Defines whether the link should be recommended to players.  
  recommend-linking: true  
  
  # Defines whether a new password should be created after the account recovery process.  
  # - If this option is disabled, a random password will be set.  
  force-password-update: false  
  
  # Sets the invitation URL of the Discord server.  
  # - This option is required to complete a link.  
  invite-url: "SERVER INVITATION"  
  
  # Sets the bot status message.  
  presence: ""
```

--------------------------------

### Configure Advanced Features

Source: https://docs.nickuc.com/nlogin/config/template

Settings for unrestricted names, inventory locking, and post-authentication command execution.

```yaml
advanced:  
  unrestricted:  
    # Defines the nicknames that will skip the authentication process.  
    #  
    # - This option can be useful for MODS or plugins that spoof  
    #   the behavior of a player.  
    #  
    #   - Examples:  
    #    - '[ThaumcraftTablet]'  
    #    - '[BuildCraft]'  
    #    - 'ComputerCraft'  
    #  
    # => Use this feature at your own risk.  
    unrestricted-names: []  

    # Sets the name of the inventories that will not be locked before login.  
    # - If you are a developer, it is best to use a higher priority for  
    #   your inventory event (e.g. HIGH or HIGHEST), and then remove  
    #   the nLogin cancel - "Event#setCancelled(false)"  
    unrestricted-inventories: []  

  # Client (player) related resources.  
  client:  
    # Define whether the nLogin language should be adapted to the Minecraft language.  
    language-by-client: false  

    # Defines the list of commands to be executed after registering.  
    #  
    # - Options available:  
    #  |=> @console: executes the command on the console.  
    #  |=> @delay <time in ticks>: adds a delay to the command.  
    #  |=> @proxy: runs the command on the proxy server (only if you are using one).  
    #  |=> @server <servers divided by ",">: executes the command only if the player is connected to a  
    #      list of specific servers (only if using a proxy server).  
    #  
    #      Example: @server lobby1,lobby2  
    #  
    commands-after-register:  
      #- "@console tell @player Welcome to the server!" # run in console  
      #- "@delay 40 /kit starter" # wait for 40 ticks (2s)  

    # Defines the list of commands to be executed after authenticating.  
    #  
    # - Options available:  
    #  |=> @console: executes the command on the console.  
    #  |=> @delay <time in ticks>: adds a delay to the command.  
    #  |=> @proxy: runs the command on the proxy server (only if you are using one).  
    #  |=> @server <servers divided by ",">: executes the command only if the player is connected to a  
    #      list of specific servers (only if using a proxy server).  
    #  
    #      Example: @server lobby1,lobby2  
    #  
    commands-after-login:  
      #- "@console @proxy send @player lobby" # run in proxy console (bungee, velocity, etc.)  

    # Sets the list of allowed commands before authenticating.  
    allowed-commands:  
      - "/loginstaff"
```

--------------------------------

### User Interface Settings

Source: https://docs.nickuc.com/nlogin/config/template

Controls the display of titles, action bars, sounds, and interactive chat components for the user.

```yaml
ui:  
  # Sets whether on-screen messages will be sent.  
  use-title-bar: true  
  
  # Sets whether messages in actionbars will be sent.  
  use-action-bar: true  
  
  # Sets whether the time remaining message will be sent.  
  actionbar-counter: true  
  
  # Sets whether sound effects will be sent.  
  use-sounds: true  
  
  # Sets whether interactive messages will be sent.  
  use-chat-component: true
```

--------------------------------

### Configure Password Security

Source: https://docs.nickuc.com/nlogin/config/template

Settings for password length constraints and regex-based strength validation.

```yaml
passwords:  
  # Sets the minimum password size.  
  small: 5  

  # Sets maximum password size.  
  large: 32  

  secure:  
    # Defines whether password strength validations should be performed.  
    enable: false  

    # Defines whether registered players should be required to update their passwords if their passwords do not meet the secure password pattern.  
    enforce: false  

    # Defines the pattern used to classify a password as secure.  
    #  
    #  | By default, it checks if the password:  
    #- |=> 1. Contains a number  
    #- |=> 2. Contains an uppercase character  
    #- |=> 3. Contains a lowercase character  
    #- |=> 4. Contains a special symbol (!”@#$%^&*?)  
    #  
    secure-regex: '(?=\S*\d)(?=\S*[A-Z])(?=\S*[a-z])(?=\S*[!@#$%^&*?])\S*$'
```

--------------------------------

### Configure Username Appender in config.yml

Source: https://docs.nickuc.com/nlogin/config/username-appender

Modify the premium.username-appender section in the nLogin configuration file to define domain-based suffixes for player accounts.

```yaml
#     ___                    _  
#    / _ \_ __ ___ _ __ ___ (_)_   _ _ __ ___   __ /\__  
#   / /_)/ '__/ _ \ '_ ` _ \| | | | | '_ ` _ \  \    /  
#  / ___/| | |  __/ | | | | | | |_| | | | | | | /_  _\  
#  \/    |_|  \___|_| |_| |_|_|\__,_|_| |_| |_|   \/  
  
# Paid features of the plugin (premium version).  
premium:  
  username-appender:  
    # Sets whether the plugin should add an extension to the nickname.  
    # - This feature is recommended to differentiate premium players from offline players.  
    #  
    # - You can change this option freely: players' data will not be lost.  
    #  
    # - For more information, please access the documentation:  
    #    * https://docs.nickuc.com/nlogin/username-appender  
    #  
    enabled: true  
  
    premium:  
      # Sets the prefix/suffix added to premium player nicknames.  
      username-appendix: ""  
  
      # Sets the position of the appendix added to premium player nicknames.  
      #  
      # - Options available:  
      #  |=> PREFIX (before nickname)  
      #  |=> SUFFIX (after nickname)  
      #  
      position: "suffix"  
  
      # Defines the list of domains that will be used to identify premium players.  
      # - Regex expressions are accepted.  
      # - The domains to be checked will always be in lower case.  
      domains:  
        - "premium.myserver.com"  
  
    offline:  
      # Sets the prefix/suffix added to offline player nicknames.  
      username-appendix: "+"  
  
      # Sets the position of the appendix added to offline player nicknames.  
      #  
      # - Options available:  
      #  |=> PREFIX (before nickname)  
      #  |=> SUFFIX (after nickname)  
      #  
      position: "suffix"  
  
      # Defines the list of domains that will be used to identify offline players.  
      # - Regex expressions are accepted.  
      # - The domains to be checked will always be in lower case.  
      domains:  
        - "myserver.com"
```

--------------------------------

### Database Configuration

Source: https://docs.nickuc.com/nlogin/config/template

Defines the table names and column mappings for the nLogin database. Modifying these values without proper database migration will cause data access errors.

```yaml
table-name: "nlogin"  
  
      # Sets the name of the columns.  
      # - Don't change this information if you don't know what you are doing!  
      columns:  
        ai: "ai"  
        last-name: "last_name"  
        unique-id: "unique_id"  
        mojang-id: "mojang_id"  
        bedrock-id: "bedrock_id"  
        password: "password"  
        premium: "premium"  
        last-ip: "last_ip"  
        last-seen: "last_seen"  
        creation-date: "creation_date"  
        email: "email"  
        discord: "discord"  
        settings: "settings"  
  
    data:  
      # Sets the name of the nLogin data table.  
      # - Don't change this information if you don't know what you are doing!  
      table-name: "nlogin_data"  
  
      # Sets the name of the columns.  
      # - Don't change this information if you don't know what you are doing!  
      columns:  
        id: "id"  
        key: "key"  
        value: "value"
```

--------------------------------

### Teleportation Settings

Source: https://docs.nickuc.com/nlogin/config/template

Configures player movement behavior, including safe location checks and death teleportation.

```yaml
teleport:  
  # Sets whether the player will be teleported to a safe position upon entering.  
  # - It is recommended to activate the option if no spawn has been set.  
  safe-location: false  
  
  # Defines if the player will be teleported to the last location upon exit.  
  last-location: true  
  
  # Defines if the player will be teleported to the spawn upon death.  
  teleport-on-death: true
```

--------------------------------

### Limbo Protection Settings

Source: https://docs.nickuc.com/nlogin/config/template

Configures the Limbo system to protect player stats and inventory before authentication. Disable hide-player-stats if using lobby plugins that manage player attributes.

```yaml
limbo:  
  # Defines whether the limbo should hide the players' information.  
  #  
  # => Player info list:  
  #  - speed and flight mode;  
  #  - speed when walking;  
  #  - life;  
  #  - satiety;  
  #  - [...]  
  #  
  # - It is recommended to disable this option in case of conflicts with other  
  #   plugins that handle these options (e.g. lobby plugins).  
  hide-player-stats: true  
  
  # Sets the time to wait for player information to be hidden.  
  #  
  # => The value provided must be in ticks. To calculate the required ticks,  
  #    multiply the value (in seconds) by 20.  
  #  
  #   - Example:  
  #      2 seconds X 20 ticks = 40 ticks  
  #  
  hide-player-stats-delay: 0  
  
  inventory:  
    # Sets whether items should be hidden before logging in.  
    hide-inventory: true  
  
  # Sets whether other players should be hidden before logging in.  
  # - This option can prevent spamming of bots in the server's player list.  
  hide-players-before-login: true  
  
  # Defines whether the movement should be locked before authenticating.  
  block-player-walk: true  
  
  # Defines whether the blinding effect will be added before logging in.  
  blindness-effect: false
```

--------------------------------

### Grant database user privileges

Source: https://docs.nickuc.com/nlogin/config/storage

SQL command to assign necessary permissions to a database user.

```sql
GRANT ALTER, DROP, SELECT, INSERT, UPDATE, DELETE ON <database name> TO <user name>@'localhost' IDENTIFIED BY '<user password>'
```

--------------------------------

### Redis Messaging Configuration

Source: https://docs.nickuc.com/nlogin/config/template

Configures Redis for cross-server messaging. Ensure the hostname and credentials are correct before enabling.

```yaml
redis:  
  # Defines Redis information.  
  enable: false  
  hostname: localhost  
  username: ""  
  password: ""  
  ssl: false
```
Tokens:
Raw