LiteLoaderBDS - Epoch-making & Cross-language Bedrock Dedicated Servers Plugin Loader

QQ Group: 656669024 QQ Group 2: 850517473

English | 简体中文

LiteLoaderBDS is an unofficial plugin loader that provides basic API support for Bedrock Dedicated Server, with a massive API, lots of packed utility interfaces, a rich event system and powerful basic interface support.

LiteLoader provides a massive API, a powerful event system and a large number of encapsulated development infrastructure interfaces, providing a solid foundation for extending the Bedrock Edition BDS with more gameplay and functionality. With plugins, it is easy to extend the functionality of BDS, the associated development is easy to learn, and the development approach is flexible.

Writing plugins in C++，Golang，JavaScript，Lua，Python and other languages, which allows developers to easily extend and customize BDS functionality, making it easy to learn and extremely flexible.

🎁 First impression

“Why should I choose LiteLoader?”

They have interface that is easy to use and intuitive!!

C++ language sample plugin

// Template project: https://github.com/LiteLDev/PluginTemplate
// More examples: https://github.com/LiteLDev/LiteLoaderPlugins
#include <EventAPI.h>
#include <LoggerAPI.h>
#include <LLAPI.h>
#include <MC/Player.hpp>
#include <MC/Actor.hpp>
Logger logger("AttackLog");

void PluginInit()
{
    logger.info("Plugin xxx has been loaded.");
    // Subscribe Player-Attack Event
    Event::PlayerAttackEvent::subscribe([](const Event::PlayerAttackEvent& ev) {
        Player* player = ev.mPlayer;
        Actor* actor = ev.mTarget;
        logger.info("Player:{} attacks {} | at {} in Dimension {}", 
         player->getRealName(), actor->getTypeName(), actor->getPos().toString(),
            std::to_string(actor->getDimensionId()));
        return true;
    });
}

Script language sample plugin (Use Js as an example)

// Register for shutdown command
mc.listen("onServerStarted", () => {
    const cmd = mc.newCommand("stopsvr", "close server", PermType.GameMasters);
    cmd.overload();
    cmd.setCallback((_cmd, ori, out, _res) => {
        const pl = ori.player;
        out.success("stop command executed successfully");
        mc.broadcast(
            `Player${pl.realName}Execute the stop command. The server will be shut down after 5 seconds`
        );

        // Execute stop command
        setTimeout(() => {
            mc.runcmd("stop");
        }, 5000);
    });
    cmd.setup();
});

💎 Advantage

💻 Support for developing plugins in many different languages, Keeping the API uniform

Supported languages	`C++`，`JavaScript`，`Lua`，`Golang`，`.Net`
Upcoming supported languages	`Python`，`Ruby`，`TypeScript`

📕 Smooth development experience with great compatibility
- Auto-generated C++ headers, access to all BDS classes and functions, full toolchain support and evolving features
- For scripting language plugins, a multi-language code completion library, a powerful VSCode plugin, a hot-loading system ...... Many tools to help you write every line of code more efficiently
- When a version is updated, the API is guaranteed to be largely backward compatible and the plugin requires little or no code changes with the version update. With the LiteLoader series' unique symbol lookup technology, cross-version auto-adaptation is no longer a dream
📋 Well documented and explained in detail
- Welcome to 👉LiteLoader documentation👈 to see more
🎈 Numerous well-packaged interfaces
- Numerous game APIs support: players, entities, cubes, items, containers, NBTs, server systems ......
- Up to 50+ game events to listen to, no matter what happens, the first to respond
🛡 Secure, stable and versatile
- Fixes a number of vulnerabilities in BDS to ensure the stability and security of your server
- Extensive use of the seh exception protection framework to minimise the risk of server crashes
- Supports running on Linux, MacOS platforms via Wine, bringing a free plugin experience to other platforms as well: write once, share on multiple platforms.
🏆 Sound app ecosystem
- A large number of existing plugins, mature publishing platform, instantly 👉Go to MineBBS👈 to find and download your favorite LL plugins
🏃 Open Source & Community Building
- The project is licensed under the AGPL-3.0 open source license and will never be charged for or released as a commercial version.
- The design philosophy is decentralised and you can be assured of a free plugin loading framework!

💻 Install

For Windows

Download the latest LiteLoader-version.zip from Releases or Actions,
Unzip everything into the directory of bedrock_server.exe. If you are prompted with conflicting files during the decompression process, just select Overwrite.
Ensure that the bedrock_server.pdb file exists. Run LLPeEditor.exe to generate the BDS with the exported symbols (bedrock_server_mod.exe)
When the console output Press any key to continue. . . , press any key to close the window
Execute bedrock_server_mod.exe and enjoy it !

For Linux

Installation script(Ubuntu)

wget https://github.com/LiteLDev/LiteLoaderBDS/raw/beta/Scripts/install.sh
chmod +x install.sh
./install.sh

Docker

Enter the following lines in your terminal:

docker pull shrbox/liteloaderbds
docker create --name liteloader -p 19132:19132/udp -i -t shrbox/liteloaderbds

Start server: docker container start liteloader
Force stop server(not recommended): docker container stop liteloader
Enter console: docker attach liteloader
Exit console: Press Ctrl + P + Q. If you press Ctrl + C, the server process will exit.
If you want to manage server files, use docker volume --help for more details.

Everything's done! Next, you can install LiteLoader plugins!

🎯 Find & Install plugins

Plugin downloads

LiteLoader main plugin distribution channels.

Plugin installation

If you downloaded a zip file, unzip it
Place all the obtained contents directly into the plugins directory
Run bedrock_server_mod.exe to start the service

For more installation and usage guides, come to 👉LiteLoader documentation👈 to view

📥 Auto update

From version 2.0.0, LiteLoader has added an auto-update function.
If in the same BDS version, LiteLoader update will automatically push, and automatically install the next time the server is started.
The latest features, get the first time! Eliminate the trouble of repeated manual upgrades!

You can use ll upgrade command at console to check for update manually too.

📕 LiteLoader plugin development

Developing plugins with C++

Go to the LiteLoader plugin template repository to download project templates, or create your own project repository based on the templates and download the code locally
Open the Template.sln project file
Start writing the plugin code in Plugin.cpp
Compile, and select the appropriate PDB file as prompted to generate the dependency libs
Copy the plugin to the plugins directory for testing

For plugins development examples and guidance, please come to 👉LiteLoader documentation👈
If you have a revision request or need to add an API, please contact the author or post an Issue

Developing plugins using scripting Languages

Create the file
Write the code
Copy the plugin to the plugins directory for testing

Please come to 👉LiteLoader documentation👈 for detailed API documentation and plugin development tutorial.
If you have a revision request or need to add an API, please feel free to contact the author or post an Issue

Example Plugins

Click here for more open source LiteLoader plugins as sample plugins. You can use them directly in production environments You can also learn plugin development methods and tips here

Development Aids - VSCode Development Aids & Complementary Libraries

Use the LiteLoader development helper plugin developed by Moxicat Helps you do better with script plugins!
Code hint, auto-completion, auto-documentation, error alert, runtime debugging ....

Click here View more description and introduction of this extension
VSCode extension store search LLScriptHelper, install LLScriptHelper and experience it instantly!

Development Aids - Blockly-LXL Graphical Development Kit

No programming foundation? Tired of complex language rules?
Have you ever thought that BDS plug-in development could be as easy as a puzzle?

Here it is! The Blockly-LXL graphical development kit from pa733 takes the plugin development experience to a new level!

Click here View related installation and usage instructions

🔨 Build project

Go to GitHub Actions to get the latest build artifact

Of course, if you prefer to build the project yourself, or contribute code to LiteLoader, you can build the project yourself by following these instructions

install the latest Microsoft Visual Studio and the standard C++ desktop development suite
Install the latest Windows SDK.
Open the LiteLoader.sln project file and click on the Batch Generation item in the Generation menu
Bring up the batch generation dialog, check all the generation checkboxes on the right side of the dialog
When you have finished selecting, click the Generate button in the dialog box to perform batch generation
After successful compilation, go back to the project root directory and execute the PackRelease.cmd script in the Scripts folder.
After execution, the contents of the RELEASE folder in the root directory will be the complete LiteLoader environment and all dependencies.

🎬 Participate in contribution

You can use the following methods to contribute to the LiteLoader project

Contribute code, maintain symbols
Help us modify and optimize development documents
Write the new API that you want in the format and submit a PR, or make good suggestions
Help us promote LiteLoader, support our development

⭐⭐⭐We welcome your contributions to LiteLoader!⭐⭐⭐

If you are interested in contributing to LiteLoaderBDS, feel free to come to 👉LiteLoader documentation👈 to view Project Maintenance and Support Documentation

📍 LICENSE

You must accept the Minecraft EULA.

It means DO NOT MAKE COMMERCIAL USE OF ANYTHING which breaks the EULA.
Accepting this LICENSE means you ACCEPTED Minecraft EULA too.
If you violate the EULA, any legal liability is IRRELEVANT to the developers.
NO WARRANTY.

Project	License
LiteLoader	AGPLv3 with extra restrictions&exceptions
BedrockX	GPLv3 with extra restrictions&exceptions
ElementZero	GPLv3
ScriptX	Apache License Version 2.0
ChakraCore	MIT License
OpenSSL	Apache-2.0 License
SimpleIni	MIT License
Nlohmann-Json	MIT License
nbt-cpp	MIT License
Hash	GPLv3
ThreadPool	Zlib License
LightWebSocketClient	MIT License
magic_enum	MIT License
dyncall	ISC license
vcproxy	MIT License
RawPDB	BSD 2-Clause License

Extra Restrictions & Exceptions

If you provide a server hosting service,you can use this framework for free, but you SHOULD NOT make PRIVATE changes to this framework or as a selling point. If you fixed or tweaked the code, please pull request, instead of making it private or using it for commercial propose.

Do not do evil.

Although we expected to build an open-source community, but forcing everything open-source will ruin this community. So you can write plugins based on LiteLoader with ANY open-source license or even don't publish your source code. but if you modified the framework, or write a new framework based on this framework, you MUST open-source it.

If you want to reproduce and distribute this framework, you have to get our authorization!