PZ Lua API Viewer

A static web app for browsing the Project Zomboid Lua API extracted from decompiled Java sources. https://geromet.github.io/PZJavaDocs/

Files

• index.html — the viewer app
• lua_api.json — extracted API data (generated by extract_lua_api.py)

Hosting on GitHub Pages

1. Create a new GitHub repository (e.g. PZJavaDocs)
2. Push the contents of this folder:

   git init
   git add index.html lua_api.json README.md
   git commit -m "Initial commit"
   git remote add origin https://github.com/YOUR_USERNAME/PZJavaDocs.git
   git push -u origin main
   

3. Go to the repo on GitHub → Settings → Pages
4. Under Source, select Deploy from a branch, choose main / (root)
5. Click Save — your site will be live at https://YOUR_USERNAME.github.io/PZJavaDocs/

Regenerating the API data

Run extract_lua_api.py from the projectzomboid/ source directory. It writes lua_api.json directly into this folder.

Features

• Browse 900+ exposed Java classes callable from Lua
• Search classes, methods, and fields
• Filter by @UsedFromLua annotation, enums, or classes with methods
• Browse 745 global Lua functions
• URL hash navigation (shareable links to specific classes)
• Press / to focus the search box

Project Zomboid Terms-Conditions

https://projectzomboid.com/blog/support/terms-conditions/