Skip to content

Settings Guide

Jump to bottom
Francisco Solis edited this page Feb 1, 2022 · 4 revisions

In this page you will see a little description for every path in every configuration file. Also you will find all the possible values that you can set

Spigot

This section is only for the Spigot Version of SuperAuth

Settings.yml

The Settings.yml file contains the basic settings such as prefix, language, sql credentials

File Content:

Prefix: '&9SuperAuth»&r' # This is the prefix of the plugin, this will be used on some in-game messages
Language: en_US # This is the language of the plugin, this will be used for the messages specified in the "translations" folder
UpdateChecker: true # True to check for updates on every start (Recommended), false to disable the update checker.
MySQL: # Those are the settings for DataBase
  Enabled: false # If is enabled the plugin will try to connect to MySQL otherwise will use SQLite. 
                 # We recommend you to use MySQL because if we update the database structure it may corrupt your data
                 # and with MySQL you won't expose your users data.
  Host: sql.example.com # Used to connect with the MySQL Server
  Port: '3306' # The port to use with the MySQL Server
  DataBase: superauth # The name of the DataBase of the MySQL Server
  UserName: superauth # The username to use while using MySQL Server
  Password: 87;-cojqX2L5}R_= # The password to use while using MySQL Server (If you delete the path, the plugin will generate a new secure password)
  UseSSL: false # True for enable the usage of SSL on the MySQL Connection, false to disable it

Auth Settings

The AuthSettings.yml file will allow you to setup the authentication features.

File Content:

AuthEnabled: true # If true the players will be requested to login/register, otherwise they won't be asked to authenticate.
                  # In booth cases you will be able to use the admin gui
HashingMethod: SHA512 # This is the method to use while hashing password. Available: 'MD2', 'MD5', 'SHA1', 'SHA256', 'SHA384' and 'SHA512'. The most recommended is 'SHA512'
AuthMethod: DIALOG # Auth Method (DIALOG, COMMANDS, GUI)
PinLength: 3 # SIze of the PIN  (Only available for GUI auth method)
PasswordLength:
  Min: 8 # Min password length (Not available for GUI auth method).
  Max: 12 # Max password length (Not available for GUI auth method).
Commands:
  Register: register # Command for the registration (Only works with auth method COMMANDS)
  Login: login # Command for the login (Only works with auth method COMMANDS)
  Auth: auth # Command for opening the Pin GUI (Only works with auth method GUI)
AntiBots:
  MaxTime: 30 # Max time for registering or logging in (in seconds)
  Captcha:
    Enabled: true # True to enable captcha (Recommended), false to disable
    Chance: 0.9 # Chance as double (every 0.1 is 10%)
    Length: 5 # Size of the asked captcha 
  BlockIPChanges: true # Set to false to disable the IP Change Blocker. We recommend to keep it as true.
Before:
  Register: # Before register actions
  - msg:&aHello! Please register yourself # Send a message to the player with PAPI support.
  Login: # Before login actions
  - msg:&aHello Again! Please authenticate yourself # Send a message to the player with PAPI support.
After:
  Register: # After register actions
  - msg:&aGreat! Now you can play # Send a message to the player with PAPI support.
  - cmd:kit nooby # Execute a command as the player
  - server:rules # Send to another server
  Login: # After login actions
  - msg:&aGreat! Now you can play # Send a message to the player with PAPI support
  - cmd:kit nooby # Execute a command as the player
  - server:lobby # Send to another server (only for networks)
WhitelistedCommands: # Commands that a player can execute when is not authorized
- register 
- login
Title:
  After:
    Login: '&bLogged In!' # The after login Title
    Register: '&bRegistered In!' # The after register Title
Subtitle:
  After:
    Login: '&7Now you can play!' # The after login Subtitle
    Register: '&7Thank you for choosing us!' # The after register Subtitle
Title-Time:
  After:
    Login: 10;20;10 # Time for fade in, stay and fade out in ticks for the login title
    Register: 10;20;10 # Time for fade in, stay and fade out in ticks for the register title
BlockedActions:
- BLOCK_BREAK # Deny the block breacking
- BLOCK_PLACE # Deny the block placing
- CHAT # Block the chat messages
- MOVEMENT # Block the movement of the player
- INTERACTION # Block the interaction like doors, levers, chests
- CUSTOM_INVENTORY # Blocks the opening of other plugin GUIs
- DAMAGE # Blocks the user damage in the server
- ITEM_DROP # Blocks the dropping of an item
Auth:
  CommandUsageTimer: 3 # Time in seconds. Every X seconds a message will be sent telling to the user how to use the command /register or /login
  Sessions:
    Enabled: true # Set to true to enable login sessions to allow a faster login 
    MaxTime: 300 # Time in seconds to expire the session. If the user exceed the max time they will be required to identify themselves again. After the server is restarted all the sessions will be invalidated

Actions

Those are the available actions for the AuthSettings: Click Here

BungeeCord

This section is only for the BungeeCord Version of SuperAuth

Settings.yml

The Settings.yml file contains the basic settings such as prefix, language, sql credentials

File Content:

Prefix: '&9SuperAuth»&r' # This is the prefix of the plugin, this will be used on some in-game messages
Language: en_US # This is the language of the plugin, this will be used for the messages specified in the "translations" folder
AuthServer: Auth # The name of the server to redirect the users who are not logged in.
BlockedActions: # A list of actions to block if the user is not authenticated
- SERVER_CHANGE # The user won't be able to navigate between servers if it's not authorized.
Commands: 
  Premium: premium # The command to enable the premium mode
  Cracked: cracked # The command to enable the cracked mode
Permissions:
  PremiumCommand: command.premium # The permission to use the premium command
  CrackedCommand: command.cracked # The permission to use the cracked command
EnabledCommands:  # List of enabled commands, can contain PREMIUM and CRACKED.
- PREMIUM
- CRACKED
MySQL: # Those are the settings for DataBase
  Host: sql.example.com # Used to connect with the MySQL Server
  Port: '3306' # The port to use with the MySQL Server
  DataBase: superauth # The name of the DataBase of the MySQL Server
  UserName: superauth # The username to use while using MySQL Server
  Password: 87;-cojqX2L5}R_= # The password to use while using MySQL Server (If you delete the path, the plugin will generate a new secure password)
  UseSSL: false # True for enable the usage of SSL on the MySQL Connection, false to disable it

Custom Translations

Follow these steps in order to create custom translations:

This guide will assume you're in the SuperAuth folder usually located in server_root/plugins/SuperAuth

  1. Disable the Translation Downloader from the file PluginData.json (Change the setting from true to false).
  2. Copy the file en.lang located inside the translations/ folder and rename the new file using the format language.lang. (For example es.lang or ru.lang)
  3. In your Settings.yml file change the value from your current language to your custom format without the .lang.
Clone this wiki locally