Config

Config File

Config divided to five files:

• main.conf: most often used settings
• extended.conf: less often used settings, some of them are experimental
• storage.conf: settings related to storage (SQLite, MySQL, MongoDB)
• translation.conf: settings related to translations, check this page
• techincal.conf: should not be changed

All of them contain comments with descriptions of each setting.
Also it can be found online in the repository

Configs are located in config/EasyAuth/ and support online reloading as well (while the server is running).
This can be done via built-in /reload command (this reloads data packs as well!) or via custom command /auth reload.

Structure

At the time of version 1.9.2 config contains the following settings:

Main part

• allowEntityInteract
  • Allows "right-clicking" on an entity (e.g. clicking on villagers) during logging process
  • Default: false
• maxLoginTries
  • Maximum login tries before kicking the player from server
  • Set to -1 to allow unlimited, not recommended however
  • Default: 1
• kickTime
  • Time after which player will be kicked if not authenticated - in seconds
  • Default: 60
• enableGlobalPassword
  • Disables registering and forces logging in with global password
  • Default: false
• globalPassword
  • Hashed global password
  • Default: null
• tryPortalRescue
  • Tries to rescue players if they are stuck inside a portal on logging in
  • Default: true
• minPasswordChars
  • Minimum length of password
  • Default: 4
• maxPasswordChars
  • Maximum length of password.
  • Set -1 to disable
  • Default: -1
• usernameRegex
  • Regex of valid playername characters. You probably don't want to change this
  • Default: "^[a-zA-Z0-9_]{3,16}$"
• sessionTimeoutTime
  • How long to keep session (auto-logging in the player), in seconds
  • Set to -1 to disable
  • Default: 3600
• spawnOnJoin
  • Whether to tp player to spawn when joining (to hide original player coordinates)
  • Default: false
• useMongoDB
  • Whether to use MongoDB instead of LevelDB.
  • Note: you need to install MongoDB yourself, as well as create a user (account) that will be used by EasyAuth to manage its database.
  • Default: false
• MongoDBConnectionString
  • Connections String for MongoDB database.
  • Documentation
  • Leave this as-is if you are using LevelDB.
  • Default: "mongodb://[username:password@]host[:port][/[defaultauthdb][?options]]"
• MongoDBDatabase
  • Name of the new database in which EasyAuth should store player data.
  • Leave this as-is if you are using LevelDB.
  • Default: "EasyAuthPlayerData"
• premiumAutologin
  • Whether players who have a valid session should skip the authentication process
  • Default: false
• forcedOfflinePlayers
  • Contains a list of lower case (!) player names that should always be treated as offline
  • Default: [""]
• hideUnauthenticatedPLayersFromPlayerList
  • Hide unauthenticated pLayers from player list
  • Note: temporarily disabled
  • Default: false

Experimental part

• preventAnotherLocationKick
  • Prevents player being kick because another player with the same name has joined the server
  • Default: true
• playerInvulnerable
  • Player should be invulnerable before authentication
  • Default: true
• playerInvisible
  • Player should be invisible to mobs before authentication
  • Default: true
• allowChat
  • Allows chat (but not commands, except for /login and /register)
  • Default: false
• allowMovement
  • Allows player movement
  • Default: false
• allowBlockUse
  • Allows block "use" - right clicking (e.g. opening a chest)
  • Default: false
• allowBlockPunch
  • Allows mining or punching blocks
  • Default: false
• allowItemDrop
  • Allows dropping items from inventory
  • Default: false
• allowItemMoving
  • Allows moving item through inventory
  • Default: false
• allowItemUse
  • Allows item "use" - right click function (e.g. using a bow)
  • Default: false
• allowEntityPunch
  • Allows attacking mobs
  • Default: false
• debugMode
  • Debug mode. Expect much spam in console
  • Default: false
• useBCryptLibrary
  • Whether to use BCrypt instead of Argon2 (GLIBC_2.25 error)
  • Default: ``
• forcedOfflineUuids
  • Whether to modify player uuids to offline style
  • Default: false
• useSimpleAuthDatabase
  • Use database from SimpleAuth which contains in mods\SimpleAuth\
  • Note: Starting with 1.9.1 EasyAuth use different folder from SimpleAuth. And this database is hard to move, so the best solution for now would be to use old DB
  • Default: false
• teleportationTimeoutInMs
  • Limit number of packets server will send to unauthorized players.
  • Note: this setting is server-wide so maximum rate would be (1000/teleportationTimeoutInMs) per seconds for all unauthorised players.
  • Value 0 would effectively disable this setting so players will be teleported after each packet, but you can expect a lot of incoming and outgoing packets (up to 3000 and more).
  • Default: 5
• enableAliases
  • Enabling or disabling aliases
  • For now, it's only affects \l as alias for \login
  • Default: true
• enableServerSideTranslation
  • Enabling or disabling aliases server-side translation
  • With enabled translation are used from resources/data/easyauth/lang/
  • While disabled translation are used from config.json
  • Default: true