{"id":18325179,"url":"https://github.com/konijima/project-zomboid-studio","last_synced_at":"2025-08-19T04:40:57.059Z","repository":{"id":166810014,"uuid":"642354568","full_name":"Konijima/project-zomboid-studio","owner":"Konijima","description":"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!","archived":false,"fork":false,"pushed_at":"2023-05-26T22:26:06.000Z","size":3468,"stargazers_count":37,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-09T13:46:29.506Z","etag":null,"topics":["modding-tool","project-zomboid"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Konijima.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-18T11:36:24.000Z","updated_at":"2025-07-30T07:49:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"490280ad-ae5f-4e2a-a9e4-083f8e03b543","html_url":"https://github.com/Konijima/project-zomboid-studio","commit_stats":null,"previous_names":["konijima/project-zomboid-studio"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Konijima/project-zomboid-studio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Konijima%2Fproject-zomboid-studio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Konijima%2Fproject-zomboid-studio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Konijima%2Fproject-zomboid-studio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Konijima%2Fproject-zomboid-studio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Konijima","download_url":"https://codeload.github.com/Konijima/project-zomboid-studio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Konijima%2Fproject-zomboid-studio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271102437,"owners_count":24699633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["modding-tool","project-zomboid"],"created_at":"2024-11-05T18:37:06.827Z","updated_at":"2025-08-19T04:40:57.030Z","avatar_url":"https://github.com/Konijima.png","language":"TypeScript","funding_links":["https://ko-fi.com/P5P2KI3EY'"],"categories":[],"sub_categories":[],"readme":"![Banner](https://github.com/Konijima/project-zomboid-studio/blob/master/.images/pzstudio-banner.png?raw=true)\n\n[![npm version](https://badge.fury.io/js/pzstudio.svg?2.0.0)](https://badge.fury.io/js/pzstudio?2.0.0)\n\nThis 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.\n\nFor 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.\n\nStart creating more powerful and versatile mods for Project Zomboid today!\n\n\u003cbr\u003e\n\n## VSCode Extentions:\n- [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.\n\n- [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.\n\n\u003cbr\u003e\n\n## Requirements:\n- [Git](https://git-scm.com/) - Require Git to clone repositories.\n- [NodeJS LTS](https://nodejs.org/en) - Require NodeJS and NPM to use the CLI commands.\n\n\u003cbr\u003e\n\n# Commands:\n\n## Install \u0026 Update\nInstall or update **Project Zomboid Studio** globally.\n```bash\nnpm install -g pzstudio\n```\n\n## New Project\nCreate a new project.\n\u003e 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.\n```bash\npzstudio new \"\u003cproject-title\u003e\" \"\u003cmod-id\u003e\"\n# ex1: pzstudio add \"My Super Cool Mod\"\n# ex2: pzstudio add \"My Super Cool Mod\" \"my-super-cool-mod\"\n```\n\n## Help\nDisplays help information.\n```bash\npzstudio help \"\u003ccommand\u003e\"\n```\n\n\u003cbr\u003e\n\n## **IMPORTANT**  \n\u003e The following commands must be executed from within a **PZStudio Project** directory.\n\n\u003cbr\u003e\n\n## Update\nUpdate **PZStudio**, **Candle** and the project.\n```bash\npzstudio update\n```\n\n## Add Mod\nAdd an other mod to your project.\n```bash\npzstudio add \"\u003cmod-name\u003e\" \"\u003cmod-id\u003e\"\n# ex1: pzstudio add \"My other mod\"\n# ex2: pzstudio add \"My other mod\" \"my-other-mod\"\n```\n\n## Rename Mod\nRename a mod from your project.\n```bash\npzstudio rename \"\u003cmod-id\u003e\" \"\u003cnew-mod-id\u003e\"\n# ex: pzstudio rename \"my-mod\" \"my-super-mod\"\n```\n\n## Delete Mod\nDelete a mod from your project.\n```bash\npzstudio delete \"\u003cmod-id\u003e\"\n# ex: pzstudio delete \"my-mod\"\n```\n\n## Add Language\nAdd a translation language.\n```bash\npzstudio lang \"\u003cmod-id\u003e\" \"\u003clanguage-code\u003e\"\n# ex: pzstudio lang \"my-mod-1\" \"en\"\n```\n\n## Copy Language\nCopy a translation language to an other language.\n```bash\npzstudio lang \"\u003cmod-id\u003e\" \"\u003cfrom-language-code\u003e\" \"\u003cto-language-code\u003e\"\n# ex: pzstudio lang \"my-mod-1\" \"en\" \"fr\"\n```\n\n## OutDir\nSet your output directory. Default: `\"\u003cuser-dir\u003e/Zomboid/Workshop/\"`\n```bash\npzstudio outdir \"\u003coutput-dir-path\u003e\"\n# ex: pzstudio outdir \"C:/Users/Konijima/Zomboid/Workshop\"\n```\n\n## Clean\nClean your output directory from the current built project.\n```bash\npzstudio clean\n```\n\n## Build\nBuild your project and update your output directory with your project.\n```bash\npzstudio build\n```\n\n## Watch\nWatch for changes and keep your output directory synced.\n```bash\npzstudio watch\n```\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n# I'm *sleepy*...\nSupport this project by fueling me with coffee.\n\n\u003ca href='https://ko-fi.com/P5P2KI3EY' target='_blank'\u003e\u003cimg height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonijima%2Fproject-zomboid-studio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkonijima%2Fproject-zomboid-studio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonijima%2Fproject-zomboid-studio/lists"}