Categorygithub.com/kldzj/pzmod
repositorypackage
2.0.1+incompatible
Repository: https://github.com/kldzj/pzmod.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

pzmod

Project Banner showing usage example

pzmod is a simple Project Zomboid server mods manager that allows you to easily install and manage mods on your server.

Features

  • Validates mods against the Steam Workshop API
  • Hints at problems with in your mod list like missing dependencies
  • Allows you to safely install mods from the Steam Workshop
  • Allows you to safely remove mods

Usage

# Will launch in interactive mode
pzmod --file path/to/servertest.ini

# Will set the servers public name
pzmod --file path/to/servertest.ini set name "My Server"

# Will list the available keys to set through the CLI
pzmod --file path/to/servertest.ini get list

A list of available commands can be found by running pzmod --help.

Requirements

  • Steam API Key (see here)
  • Installed Project Zomboid server (or at least a servertest.ini file)

Download

You can download the latest version of pzmod from the releases page.

Linux users can also install pzmod using the following command:

# Will install the latest version of pzmod to /usr/local/bin
curl -fsSL https://raw.githubusercontent.com/kldzj/pzmod/main/install.sh | bash -s

# To override the install location, pass the target as an argument
curl -fsSL https://raw.githubusercontent.com/kldzj/pzmod/main/install.sh | bash -s -- /home/user/bin/pzmod

or if you are more of a 'do not pipe to shell' kind of person:

curl -fsSL https://raw.githubusercontent.com/kldzj/pzmod/main/install.sh -o install.sh
less install.sh # Read the script to make sure it is safe
chmod +x install.sh

# Will install the latest version of pzmod to /usr/local/bin
./install.sh

# To override the install location, pass the target as an argument
./install.sh /home/user/bin/pzmod