Flux Loader

Flux Loader is a universal toolchain for creating plugins (mods) for the Project Zomboid game, oriented for both the client and the server. This project is inspired by tools such as Storm, PaperMC, FabricMC, etc.

The problem of writing mods for Project Zomboid is largely due to the lack of detailed documentation and the limitations of the official API designed for modding. The main way to create mods through Lua provides only limited features, which poses certain difficulties for mod developers if they want to implement more complex and deep functionality. This means that developers have to use workarounds to implement more complex ideas and concepts, which can lead to increased development complexity and potential compatibility and stability problems.

In addition, the lack of official support for such methods may lead to the risk that mods may stop working with future updates of the game. All this affects mod developers, limiting their creativity and increasing the risks during development.

That is why, inspired by popular mod loaders in other games (for example, Minecraft), where you can easily expand the functionality of the game, it was decided to create a tool that solves these problems.

Our tools already have:

• 200+ default and custom events (with documentation) that you can easily subscribe to;
• The ability to load custom Lua scripts;
• Custom translation system for plugins;
• Working with client and server sides;
• Custom documented tools for working with game methods;
• Availability of Wiki, which reveals in detail the process of creating a plugin;
• Creating plugins for FluxLoader is very similar to creating plugins from Minecraft mod loaders (Paper, Fabric, Bukkit, etc);
• The ability to easily add plugins by moving the Jar file to the plugins folder.

To install this project, you need to do the following:

1. Download the latest version from the releases page
2. Transfer the downloaded Jar archive to the game folder (for the server, place it in the java subfolder).
3. Open the terminal (Windows command prompt) in the folder where the downloaded Jar file is located. Or enter the following command

cd /D "path"

cd - command to change the terminal context

/D - the flag is necessary to change the directory (disk), you do not need to change it

path - is your path to the jar file folder

5. Enter the installation command in the context of the folder with the downloaded jar file:

java -jar ./FluxLoader-x-x-x.jar --install

java - JDK CLI call

-jar - flag for working with jar

./FluxLoader-x-x-x.jar - archive file name, where x is the file version

--install - flag for installing the tool.

After the successful installation of Flux Loader, you can write and/or download ready-made plugins and transfer them to the plugins folder, it is located in the game folder, in the same place as the main folder of the game zombie

If you are a developer or just want to get acquainted with the documentation about available methods, events, etc., you can look in our Wiki. As the project develops, it will be expanded and corrected.

This software is provided "as is", without any express or implied warranties. The team is not responsible for mods created by developers using the Flux Loader API.

We welcome any help in the development of this project! How can you help:

• Test - install the loader and just play. Mods are not necessary to install, so you will help find hidden bugs. If something turns up, please report it to Issue so that other developers know what needs to be fixed.
• Create mods - is a good way to develop our community and bring new functionality to the game.
• Take part in the development - you can always create a fork and make corrections by sending them for acceptance (pull request).
• Join our community at discord - we want to create a healthy community of enthusiastic developers where everyone can learn something and find new friends.

This project is licensed under GNU General Public License v3.0.