Avrix is a modern, modular Java-based mod loader for Project Zomboid (client and dedicated server), powered by on-the-fly mixin bytecode transformation.

✨ Features

• Mixin Technology: Native support for Sponge-style mixin annotations powered by ClassTransform and ASM bytecode manipulation.
• Unified Classloading: Flat knot-classloader architecture ensuring zero classloader visibility barriers and fast class resolution.
• Universal Environment: Works out of the box on both graphical clients and headless dedicated servers (Windows, Linux, macOS).
• Automated Dependency Resolution: Strict semantic versioning (SemVer) validation and DAG topological sort for plugin load order.
• Zero-Friction Modding: Drop plugin .jar files into the plugins/ directory to load them.

📚 Documentation

Visit the official documentation to choose your preferred language and get detailed guides on installation, configuration, and plugin development:

📄 Open Documentation

🚀 Quick Start

1. ⬇️ Download the latest executable JAR from the Releases Page.
2. 📁 Place the Avrix-Loader-<version>.jar file into the root folder of your Project Zomboid installation (client or dedicated server).
3. 💡 Launch the game via the command line or custom startup script:

java -jar ./Avrix-Loader-x.x.x.jar

For dedicated servers with Steam integration disabled, append -nosteam:

java -jar ./Avrix-Loader-x.x.x.jar -nosteam

Note

Logging Level: You can adjust the loader log verbosity using the -Dconsole.level=TRACE (or DEBUG, INFO, WARN, ERROR) JVM flag: java -Dconsole.level=TRACE -jar ./Avrix-Loader-x.x.x.jar

Raw Game Logs: Pass the --no-redirect-log flag to disable Avrix stream interception and restore default Project Zomboid console output: java -jar ./Avrix-Loader-x.x.x.jar --no-redirect-log

🤝 Contributing

Contributions are always welcome! Here is how you can help:

• 🧪 Testing: Install Avrix and run your server or client. If you encounter an unexpected crash or issue, please report it on GitHub Issues.
• 🔌 Build Plugins: Create new mods and plugins for the community and share them on GitHub.
• 💻 Code Contributions: Fork the repository, create a feature branch, and submit a Pull Request.
• 💬 Join Discord: Connect with other modders, get support, and discuss development in our Discord Community.

⚖️ License

This project is licensed under the MIT License.