Avrix - is a modern Java-based mod(plugin) loader for Project Zomboid (client and server), powered by mixin technology.

Note

Avrix-Loader is a plugin and mixin loader only — it does not provide a Project Zomboid API. All game-specific utilities, events, and helpers are shipped in the optional Avrix-API plugin.

✨ Features

• Powered by mixin technology (implementation via ClassTransform)
• Designed for both client and server environments
• Simple mod installation: just drop the JAR file into the plugins/ folder
• Streamlined mod development, following the same patterns as FabricMC
• Essential API, events, commands, and utilities for mod development — Avrix-API

📚 WIKI and important information

Important

Avrix Loader requires: JDK 25+ and Project Zomboid - beta 42+

TODO: Later, there will be a detailed description of how to start developing plugins (although the loader is already capable of loading and executing modifications)

🚀Quick Start

1. ⬇️ Download the executable Jar file from the releases page
2. 📁 Move the downloaded files to the root folder of the client/server
3. 💡 Run the downloaded JAR file using the CMD run command:

java "-Djdk.attach.allowAttachSelf=true" -XX:+EnableDynamicAgentLoading -jar ./Avrix-Loader-X.X.X.jar

🤝 Contribute

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 plugins - 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.

⚖️ License

This project is licensed under MIT license.