https://github.com/konijima/project-zomboid-studio
Effortlessly create and maintain Lua mods for Project Zomboid with this intuitive tool. Streamline your mod structuring, simplify the creation process, and dynamically monitor and respond to changes. Enhance your modding experience and efficiency today!
https://github.com/konijima/project-zomboid-studio
modding-tool project-zomboid
Last synced: 10 months ago
JSON representation
Effortlessly create and maintain Lua mods for Project Zomboid with this intuitive tool. Streamline your mod structuring, simplify the creation process, and dynamically monitor and respond to changes. Enhance your modding experience and efficiency today!
- Host: GitHub
- URL: https://github.com/konijima/project-zomboid-studio
- Owner: Konijima
- License: apache-2.0
- Created: 2023-05-18T11:36:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-26T22:26:06.000Z (about 3 years ago)
- Last Synced: 2025-08-09T13:46:29.506Z (10 months ago)
- Topics: modding-tool, project-zomboid
- Language: TypeScript
- Homepage:
- Size: 3.31 MB
- Stars: 37
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://badge.fury.io/js/pzstudio?2.0.0)
This is an intuitive and efficient solution to create and maintain Lua mods for Project Zomboid with greater ease. The tool allows for effortless structuring of mods, reducing time and complexity typically associated with mod creation. Key features include the ability to 'Build' and 'Watch' for changes, enhancing workflow and enabling dynamic mod adjustments.
For seamless coding and guidance, we leverage the [asledgehammer/Candle](https://github.com/asledgehammer/Candle) and [demiurgeQuantified/PZEventDoc](https://github.com/demiurgeQuantified/PZEventDoc) libraries, offering intelligent code completion (IntelliSense) for Lua.
Start creating more powerful and versatile mods for Project Zomboid today!
## VSCode Extentions:
- [Lua](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) - The Lua language server provides various language features for Lua to make development easier and faster. With around half a million installs on Visual Studio Code, it is the most popular extension for Lua language support.
- [ZedScript](https://marketplace.visualstudio.com/items?itemName=asledgehammer.zedscript-vscode) - A third-party VSCode extension for supporting ZedScript, a scripting format for creating Items, Recipes, etc.
## Requirements:
- [Git](https://git-scm.com/) - Require Git to clone repositories.
- [NodeJS LTS](https://nodejs.org/en) - Require NodeJS and NPM to use the CLI commands.
# Commands:
## Install & Update
Install or update **Project Zomboid Studio** globally.
```bash
npm install -g pzstudio
```
## New Project
Create a new project.
> You can create a project anywhere on your computer, but **DO NOT** create it inside your Mods and Workshop directory. The build command will generate the actual mod into the Workshop directory or any output directory you set.
```bash
pzstudio new "" ""
# ex1: pzstudio add "My Super Cool Mod"
# ex2: pzstudio add "My Super Cool Mod" "my-super-cool-mod"
```
## Help
Displays help information.
```bash
pzstudio help ""
```
## **IMPORTANT**
> The following commands must be executed from within a **PZStudio Project** directory.
## Update
Update **PZStudio**, **Candle** and the project.
```bash
pzstudio update
```
## Add Mod
Add an other mod to your project.
```bash
pzstudio add "" ""
# ex1: pzstudio add "My other mod"
# ex2: pzstudio add "My other mod" "my-other-mod"
```
## Rename Mod
Rename a mod from your project.
```bash
pzstudio rename "" ""
# ex: pzstudio rename "my-mod" "my-super-mod"
```
## Delete Mod
Delete a mod from your project.
```bash
pzstudio delete ""
# ex: pzstudio delete "my-mod"
```
## Add Language
Add a translation language.
```bash
pzstudio lang "" ""
# ex: pzstudio lang "my-mod-1" "en"
```
## Copy Language
Copy a translation language to an other language.
```bash
pzstudio lang "" "" ""
# ex: pzstudio lang "my-mod-1" "en" "fr"
```
## OutDir
Set your output directory. Default: `"/Zomboid/Workshop/"`
```bash
pzstudio outdir ""
# ex: pzstudio outdir "C:/Users/Konijima/Zomboid/Workshop"
```
## Clean
Clean your output directory from the current built project.
```bash
pzstudio clean
```
## Build
Build your project and update your output directory with your project.
```bash
pzstudio build
```
## Watch
Watch for changes and keep your output directory synced.
```bash
pzstudio watch
```
# I'm *sleepy*...
Support this project by fueling me with coffee.
