mcbe-portal README

mcbe-portal is a simple, customizable library to manage Minecraft Bedrock Edition servers with ease. It allows you to configure backups, manage scripts, and automate server creation. With mcbe-portal, you can handle server creation and backups with minimal setup.

Features

• Server Creation: Easily create new servers with simple configurations.
• Server Generation: If you start a server and there is no server software, we will download it for you.
• Backups: Set up automatic backups for your servers at customizable intervals.
• Database: Optionally enable cross-server database support.
• Global Packs: Add global script packs to your servers.
• Plugins: Use plugins to enhance your mcbe-portal experience.

Installation

To install mcbe-portal in your project, run:

npm install mcbe-portal

Usage

To run the application simply run:

node .

Configuration

Below is an example of how to configure and use the portal to manage your Minecraft Bedrock Edition servers:

const { Portal } = require("mcbe-portal");
const { API } = require("mcbe-portal-plugins");

const portal = new Portal({
    backups: {
        enabled: true,                    // Enable the backup system
        active: ["Hub"],                  // List of active servers that require backups
        interval: 12 * 60 * 60 * 1000     // Set the interval of backups (Default interval is 12 hours)
    },
    database: {
        enabled: true                     // Enable database support for server management
    },
    packs: {
        enabled: true,                    // Enable script support
        uuids: ["<UUID>"],                // List of script packs to load
        exlcude: ["<SERVER NAME>"]        // List of servers you want to exclude from the global packs
    },
    prefix: "--",                         // Command prefix for executing actions
    plugins: [API]                        // Plugins to enchance your experience
});

// Create a server named "Hub" in the specified directory
portal.create_server("Hub", "./servers/home");

Explanation of Configuration

• backups.enabled: Enable or disable the backup system.
• backups.active: A list of active servers that should be backed up.
• database.enabled: Enable or disable database support for your servers.
• packs.enabled: Enable or disable the use of packs.
• packs.uuids: A list of pack UUIDs to be applied to your servers.
• packs.exclude: A list of servers you want to exclude from the global packs.
• prefix: The command prefix used to execute actions.
• plugins: Plugins you want to run on your servers.

Automatic Backups

The backups() function is set to perform backups manually and automatically every 12 hours. This ensures that your servers remain safe and recoverable.

Command Line Interface

You can use the mcbe-portal library with your custom commands by prefixing them with the configured prefix. For example, the default prefix is --.

License

MIT License. See LICENSE file for more details.