How to install LockLogin

How to install the plugin?

Installing LockLogin is really easy, specially for bungee/velocity in comparation with other plugins;

In single environment ( bukkit, spigot, paper... )

1. Download the latest version of the plugin
2. Put the downloaded jar in your plugins folder
3. Start your server

In multiple enviroment ( bungee, velocity... )

1. Download the latest version of the plugin
2. Put the downloaded jar in your PROXY plugins folder, AND IN ALL YOUR SINGLE ENVIROMENT SERVERS PLUGINS FOLDER
3. Start your proxy and servers

In multiple enviroment, with multiple proxies

1. Download the latest version of the plugin
2. Put the downloaded jar in all your PROXY plugins folder, AND IN ALL YOUR SINGLE ENVIROMENT SERVERS PLUGINS FOLDER
3. Start all your proxies
4. Stop all your proxies
5. For each proxy, open: (plugins/LockLogin/proxy.yml), which will look like this:

###########################################################
#                                                         #
#   LockLogin source is a plugin under GSA GPL license    #
#           https://karmaconfigs.ml/license               #
#                                                         #
#                                                         #
#                   This configuration                    #
#              file manages multi-bungee and              #
#           auth/lobby servers configuration...           #
#                                                         #
###########################################################

#Manage LockLogin proxy options
#
# MultiBungee -> Enables multiple bungeecord support
# AuthServers -> Allows LockLogin to send players to auth-lobby or main-lobby
#                depending on their session status
Options:
  MultiBungee: false
  SendToServers: true

#This must be the same for all
#the proxy instances! You can write here
#whatever you want. BUT MUST BE THE SAME
#AS YOUR OTHER PROXY.YML CONFIGURATION FILES
ProxyKey: ""

#PLEASE DO NOT MODIFY THIS, THIS IS
#YOUR UNIQUE BUNGEECORD PROXY ID
#AND THIS WILL BE USED FOR MULTI-BUNGEE
#IF ENABLED
ID: ""

#Karma remote messaging protocol info.
#The address is the IP address in where this
#server remote messaging will be hosted, and the port
#is the port that will listen for new connections.
#
#By default, there are no extra steps while all servers are running locally
#but if your bungee server is out of your network, for example, in another VPS
#which is not the same as your spigot servers, then you should CHANGE and
#OPEN the port for TCP, and also change the Address to the local IPv4 address
Channel:
  Address: "127.0.0.1"
  Port: 49305

#Manage which servers will use LockLogin
# This works like server-priority of bungee's configuration,
# the plugin will try with the first, if fail with the second
# and like that until the list ends or the player-server-send is success.
#
# To use all the servers you can use '*' or add all of them manually
Servers:
  Lobby:
    - "lobby"
    - "lobbyFallBack"
  Auth:
    - "auth"
    - "authFallBack"

6. Edit ProxyKey and make it match with all your proxies proxy.yml configuration
7. Start your proxies and servers

Installing modules

LockLogin API works a bit different in comparation from other plugins. To enforce the security between the plugin and the server, LockLogin API must be accessed trough a LockLogin module plugin

A LockLogin module plugin, is a plugin, but for LockLogin, being able to add functionalities to it.

The installation process for modules is the same on all platforms, and it's relative easy. Just drag and drop the module jar file into plugins/LockLogin/plugin/modules