Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Greens-Organization/pz-packs/llms.txt

Use this file to discover all available pages before exploring further.

​
Mod Browsing & Management

PZ Packs maintains a comprehensive database of Project Zomboid mods from the Steam Workshop. Browse, search, and add mods to your modpacks with detailed metadata and automatic updates.

​
Browsing Mods

The mod browser provides a searchable, filterable view of all available Project Zomboid mods in the PZ Packs database.

​
Accessing the Mod Browser

  1. Navigate to the “All Mods” page from the main navigation
  2. View mods in a grid layout with key information displayed on each card
  3. No authentication required to browse the mod catalog

​
Mod Display Information

Each mod card shows:

Basic Info

  • Mod name
  • Mod avatar/thumbnail
  • Steam Workshop ID
  • Description preview

Metadata

  • Tags and categories
  • Required dependencies
  • Map folders (if applicable)
  • Last update timestamp

​
Searching and Filtering

Find specific mods quickly using the built-in search and filter capabilities.

​
Search Options

Search mods by name or description:
  • Enter keywords in the search bar
  • Search is case-insensitive
  • Results update as you type
  • Matches against mod names and descriptions

​
Pagination

The mod browser displays mods in pages to improve performance:
  • Default: 20 mods per page
  • Navigate using the pagination controls at the bottom
  • Page numbers update based on active filters

​
Mod Metadata

PZ Packs stores comprehensive metadata for each mod, synced from Steam Workshop.

​
Core Metadata Fields

Workshop ID (required)The unique Steam Workshop identifier for the mod. This is used to:
  • Download the mod from Steam
  • Check for updates
  • Link to the Steam Workshop page
Example: 2876012699
Mod IDs (array)Some mods contain multiple sub-mods or components. Each component has its own Steam Mod ID:
"steamModId": [
  "ModName1",
  "ModName2",
  "ModName3"
]
These IDs appear in the Mods= line of server configuration files.
Map Folders (optional array)For mods that add custom maps, this field contains the map folder names:
"mapFolders": [
  "CustomMapName",
  "AnotherMap"
]
Map folders are included in the Map= line of server configs.
Dependencies (optional array)Lists other mods required for this mod to function:
"requiredMods": [
  "RequiredModWorkshopId1",
  "RequiredModWorkshopId2"
]
PZ Packs displays required mods but does not automatically add dependencies to your modpack. You must manually add required mods.
Tags (array of tag references)Mods are categorized using tags for easier discovery:
  • Tags are managed globally in the system
  • Multiple tags can be assigned to each mod
  • Used for filtering in the mod browser
  • Name: The mod’s display name
  • Description: Full mod description from Steam
  • Highlights: Key features or selling points
  • Avatar URL: Thumbnail image from Steam Workshop
  • Steam URL: Direct link to the Workshop page

​
Adding Mods to Modpacks

Add mods to your modpack using Workshop IDs or Steam URLs.
1

Open Your Modpack

Navigate to the modpack details page where you want to add mods.
2

Click Add Mod

Click the “Add Mod” button to open the add mod dialog.
3

Enter Mod Information

Provide either:
  • Workshop ID: The numeric ID from the Steam Workshop URL
  • Steam URL: The full Steam Workshop URL for the mod
Examples:
  • Workshop ID: 2876012699
  • Steam URL: https://steamcommunity.com/sharedfiles/filedetails/?id=2876012699
4

Add the Mod

Click “Add Mod” to add it to your modpack. The system will:
  • Check if the mod exists in the PZ Packs database
  • Fetch mod details from Steam if it’s a new mod
  • Add the mod to your modpack’s mod list
You need the add-mod permission to add mods to a modpack. Owners have this permission by default. See Team Collaboration for permission details.

​
Automatic Mod Fetching

When you add a mod that doesn’t exist in the PZ Packs database:
  1. The system fetches mod information from Steam Workshop API
  2. Mod metadata is stored in the database for future use
  3. The mod becomes available in the global mod browser
  4. The mod is added to your modpack

​
Removing Mods from Modpacks

Remove mods you no longer need from your modpack.
  1. Navigate to your modpack’s mod list
  2. Find the mod you want to remove
  3. Click the remove/delete button on the mod card
  4. Confirm the removal in the dialog
Removing a mod from a modpack does not delete the mod from the PZ Packs database. It only removes the association between the mod and your modpack.

​
Permissions Required

  • Owner: Can remove any mod
  • Members with remove-mod permission: Can remove mods from the modpack
See Team Collaboration for more on permissions.

​
Mod Configuration

Some mods have multiple Steam Mod IDs. PZ Packs allows you to select which IDs to include in exports.

​
Selecting Steam Mod IDs

When configuring your export settings:
  1. Open the “Reorder & Configure Export” view
  2. For mods with multiple Steam Mod IDs, you’ll see checkboxes for each ID
  3. Select/deselect IDs to include in your server configuration export
  4. Save your configuration
By default, all Steam Mod IDs for a mod are selected. Deselecting all IDs for a mod will exclude it from the export entirely.

​
Use Cases

Modular Mods

Some large mods have optional components. Select only the components you need for your server.

Compatibility

Exclude specific mod components that conflict with other mods in your collection.

​
Updating Mod Information

Mod information in PZ Packs is synced from Steam Workshop. Mods can be updated individually or in bulk.

​
Update Single Mod

Requires update permission (admin only by default).
  1. Navigate to the mod details page
  2. Click “Update Mod” or the refresh icon
  3. The system fetches the latest information from Steam Workshop
  4. Mod metadata is updated in the database

​
Update All Mods

Administrators can trigger a bulk update of all mods in the database:
  1. Navigate to the “All Mods” page
  2. Click “Update All Mods” button (admin only)
  3. The system queues updates for all mods
  4. Mods are updated in the background
Updating all mods can take significant time. This operation runs as a background job to avoid blocking the interface.

​
Mod Detail View

Click on any mod card to view comprehensive mod information.

​
Information Displayed

  • Full mod name and description
  • Mod avatar/thumbnail
  • Steam Workshop link
  • Last updated timestamp
  • Created date

​
Mod List in Modpacks

When viewing a modpack, you’ll see a list of all mods in that collection.

​
List Features

  • Pagination: Navigate through large mod lists
  • Search: Filter mods within the modpack
  • Sorting: Reorder based on various criteria
  • Card View: Each mod displayed with key information

​
Reordering Mods

Set the load order for mods in your modpack:
1

Open Reorder Interface

Click “Reorder Mods” or “Configure Export” from the modpack page.
2

Drag and Drop

Drag mod cards to reorder them. The top mod loads first.
3

Use Quick Actions

Use the arrow buttons to:
  • Move mod up one position
  • Move mod down one position
  • Move mod to top
  • Move mod to bottom
4

Save Order

Click “Save” to persist the mod load order.
The mod order is saved in the modpack metadata and used when generating server configuration files.

​
Best Practices

  • Check mod compatibility before adding to your modpack
  • Read mod descriptions carefully for known conflicts
  • Test mods together before deploying to a server
  • Keep track of required dependencies
  • Place framework/library mods first
  • Group related mods together
  • Put map mods after core gameplay mods
  • Test the load order in single-player before using on servers
  • Periodically check for mod updates
  • Review mod compatibility when Project Zomboid updates
  • Remove abandoned or broken mods
  • Update mod descriptions if you notice changes
  • Always add required mods to your modpack
  • Check dependency versions for compatibility
  • Note dependencies in your modpack description
  • Test thoroughly when adding mods with complex dependencies

​
Next Steps

Export Server Files

Generate server configuration files with your selected mods

Modpack Management

Learn more about organizing and managing modpacks

Team Collaboration

Share modpack management with team members

API Reference

Programmatically access mod data via API

Build docs developers (and LLMs) love

Get started for freeTalk to us