Managing and organizing scripts with folders

Overview:

This guide will explain how to create organized structures with scripts. Since OpenJS 1.3.0, scripts will get automatically loaded even if they are inside a folder and named main.js/Main.js.

Example:

main.js

let module = requireScript("Modules/ExampleModule.js");
// Run functions in main thread because scripts run on an async thread by default
task.main(function() {
    log.info("Total players: " + module.getTotalPlayers());
    log.info("Total entities: " + module.getTotalEntities());
    log.info("Total worlds: " + module.getWorldCount());
})

Modules/ExampleModule.js

var Bukkit = org.bukkit.Bukkit

return { 
    getTotalPlayers: function() {
        try {
            return Bukkit.getOnlinePlayers().size();
        } catch (error) {
            log.error("Error getting player count: " + error);
            return 0;
        }
    },

    getTotalEntities: function() {
        var totalEntities = 0;

        try {
            var worlds = Bukkit.getWorlds();

            for (var i = 0; i < worlds.size(); i++) {
                var world = worlds.get(i);
                var entities = world.getEntities();
                totalEntities += entities.size();
            }

            return totalEntities;
        } catch (error) {
            log.error("Error getting entity count: " + error);
            return 0;
        }
    },

    getWorldCount: function() {
        return Bukkit.getWorlds().size();
    }
}

Output:

• The name of scripts that are inside folders are their folders name (as seen in the output)

• Required scripts will run under the same environment as the main script, more info here

• Use the script-class to get the information on the current script (name, path, etc)

• If you want to jump out of the path via any function that expects a path use ".." Example: Current path: "C:\Folder\CurrentFolder\main.js" Target path: "C\:Folder\someScript.js" Final path: "..\someScript.js" ⇒ "C\:Folder\someScript.js"