Home

Wiki (Relevant on v1.5.X)

Writing mods for any game can be a challenging task for beginners, especially without proper documentation. If you decide to start expanding the capabilities of Project Zomboid, we will try to help you with this. First of all, we recommend reading the basics on writing modifications.

Avrix provides many more features than it might seem at first glance. You can familiarize yourself with all internal processes through the source code, and you can find example plugin in the github repository.

Note

Avrix has a custom TinyLog2 logging system. All log files are stored in the {rootGameFolder}/avrix/logs path

We also highly recommend that you familiarize yourself with these resources, they will greatly help you understand the logic of the game:

• Project Zomboid Java Doc
• Project Zomboid Events
• Avrix Java Doc
• Avrix Events

Content

• Beginning
• Using events
• Patches
• Console/Server commands
• Configuration files
• Services
• UI, Font and HUD
• Compilation
• Start server
• Start client