Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kldzj/pzmod
A simple Project Zomboid mods manager for dedicated servers
https://github.com/kldzj/pzmod
mod-manager project-zomboid
Last synced: about 1 month ago
JSON representation
A simple Project Zomboid mods manager for dedicated servers
- Host: GitHub
- URL: https://github.com/kldzj/pzmod
- Owner: kldzj
- License: mit
- Created: 2022-09-04T15:50:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T12:15:54.000Z (8 months ago)
- Last Synced: 2024-04-19T13:35:57.363Z (8 months ago)
- Topics: mod-manager, project-zomboid
- Language: Go
- Homepage:
- Size: 263 KB
- Stars: 11
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## pzmod
**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
```bash
# 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](https://steamcommunity.com/dev/apikey))
- Installed Project Zomboid server (or at least a `servertest.ini` file)
### Download
You can download the latest version of **pzmod** from the [releases page](https://github.com/kldzj/pzmod/releases).
Linux users can also install **pzmod** using the following command:
```bash
# 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:
```bash
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
```