https://github.com/konijima/pzpw-pipewrench

PipeWrench repo for PZPW
https://github.com/konijima/pzpw-pipewrench

pipewrench pzpw

Last synced: 11 days ago
JSON representation

PipeWrench repo for PZPW

• Host: GitHub
• URL: https://github.com/konijima/pzpw-pipewrench
• Owner: Konijima
• License: mit
• Created: 2022-08-16T01:19:26.000Z (over 2 years ago)
• Default Branch: stable
• Last Pushed: 2022-08-16T06:54:22.000Z (over 2 years ago)
• Last Synced: 2024-11-05T18:55:08.062Z (about 2 months ago)
• Topics: pipewrench, pzpw
• Language: Lua
• Homepage:
• Size: 960 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# PipeWrench (For PZPW)

[![Build](https://github.com/Konijima/pzpw-pipewrench/actions/workflows/Build.yml/badge.svg)](https://github.com/Konijima/pzpw-pipewrench/actions/workflows/Build.yml)

PipeWrench is a set of TypeScript definitions for both the Java API and Lua codebase for the game Project Zomboid.

## Advantages

- TypeScript provides type safety where Lua does not. 

- Code with errors will not compile in most TypeScript environments for improper usages of types.

- Writing Lua works with PipeWrench. (Lua Interfaces & separate Lua files)

## Caveats

- TypeScriptToLua Caveats: https://typescripttolua.github.io/docs/caveats

- Lua types are in BETA. 

  - `lua/client/Context` and a couple other design patterns aren't processed so these calls will need their own Lua interfaces built manually.

# Support

![](https://i.imgur.com/ZLnfTK4.png)

## Discord Server

https://discord.gg/u3vWvcPX8f

If you like what I do and helped your community a lot, feel free to buy me a coffee!

https://ko-fi.com/jabdoesthings

https://www.paypal.com/paypalme/JabJabJab