README.md

LockLogin2

LockLogin2 is the new version of LockLogin. With a better API and more stability
LockLogin is a free open-source authentication plugin for minecraft, compatible with spigot, bungeecord and "multi-bungee". LockLogin is designed to enforce the server and the client security, with tons of premium features for free, such as pin login, TOTP and also some other unique features, such as the panic token, or virtual IDs.
LockLogin is open source, which means anyone can contribute to it, even thought there official authors, LockLogin is a community plugin with no real owner who has authority over it. Any change can be voted in RedDo discord.
LockLogin has also multi-language support, so you can search on the official official resources for any official language or module you need or even you can search for community modules and community translations to extend the plugin functionalities and security.

* Every community resource can be installed from game by using the LockLogin resource-manager command (lrm)

API

LockLogin API was made to avoid external plugins access it, for security reasons, so no external plugin is allowed to interact with the most important parts of the API. This helps your server to still safe. Anyway, LockLogin provides a way for developers to access its API, and that's by the use of modules.
The LockLogin Modules are an essential part of the LockLogin API as they are the only one whith access to the plugin API, and the best is that everything that the module does gets logged, in case there's a security breach it will be easier to determine which module (if any) caused that breach.

You can learn on how to create a module for LockLogin in the LockLogin wiki[Under construction] or If you need more help when developing the module, you can have a look at the LockLogin docs[Under construction]

You can also have a look on the module examples.

Can I use my existing plugin as a module?

Yes, unlike in LockLoginReborn (LockLogin legacy v2), a plugin can be extended into a module, without even the need of making your plugin have module-required files or implementing the LockLogin module class, instead, you simply need to call a LockLogin method which asks your plugin as parameter in order to extend your plugin into a module virtually

Plugin API

In LockLogin2 the API now allows a plugin to be extended into a module in runtime. This is possible by generating a virtual module instance by using your plugin information. That way you can extend your existing plugin into a module without having to do changes. All you need to do is call a simple method

public class Main extends JavaPlugin {
    
    public void onEnable() {
        LockLogin locklogin = CurrentPlugin.getPlugin();
        ModuleConverter<JavaPlugin> converter = locklogin.getConverter();

        converter.extend(this);
        /*
        You can use the static onEnable and onDisable methods
        in order to catch when the module is ready to handle
        the LockLogin stuff (recommended) or take a risk and
        use directly the return value of ModuleConverter#extend, 
        which always return a Module (nullable)
         */
    }

    /**
     * Virtual module enable logic
     * 
     * @param module the current module instance
     */
    public static void onEnable(final Module module) {
        getLogger().info("Successfully hooked with LockLogin");
    }

    /**
     * Virtual module disable logic
     * 
     * @param module the current module instance
     */
    public static void onDisable(final Module module) {
        //TODO: Disable logic
    }
}

Migrating from LockLoginReborn (Legacy v2) (>1.1.0.9)

LockLoginReborn is the previous version to this version of LockLogin. Any version under LockLogin v2.0.0 will be marked as legacy since this version releases officially. Which means that no more support will be provided for those versions. No more dependency updates nor bug fixes, as the support will be moved to this version of LockLogin.
This also includes accounts and any kind of data managed by the plugin in the legacy version. Fortunately, LockLogin2 is compatible with the legacy data systems, even thought it has been built from scratch, LockLogin2 will do its best migrating the detected legacy data into the new systems. There's no manual work for you, the plugin will do everything for you, so migrating should work just like a simple update.
Even though LockLogin will try to migrate all the legacy data, there's still some information that WON'T be migrated, those are:

• Name tables
• UUID tables
• IP address tables
• 2FA scratch codes (now renamed to TOTP Scratch codes)
• Locations (last location and spawn)

Work is in progress to add support for locations and 2fa scratch codes, but those might arrive later

Migrating from LockLogin (Legacy v1) (<1.12.16)

Unfortunately, LockLogin Legacy v1 won't be able to be migrated to LockLogin2 as LockLogin expects the user to update the plugin when the plugin asks for it. Upgrading from a very old legacy version (v1) to a modern legacy version (v2) is neither recommended, as there are too many changes betwen those versions. LockLogin has evolved fast and in big steps. That's the reason of why updating LockLogin when asked is highly recommended.
The only option you have if you want to migrate from LockLogin Legacy v1 to LockLogin2 is to whipe all your LockLogin data and perform a fresh installation.