Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Node command-line tool to compile PZPW projects.
https://github.com/konijima/pzpw-compiler

compiler npm-module pipewrench pzpw

Last synced: about 2 months ago
JSON representation

Node command-line tool to compile PZPW projects.

Awesome Lists containing this project

README

        

# PZPW Compiler

[![Lint](https://github.com/Konijima/pzpw-compiler/actions/workflows/Lint.yml/badge.svg)](https://github.com/Konijima/pzpw-compiler/actions/workflows/Lint.yml)
[![Build](https://github.com/Konijima/pzpw-compiler/actions/workflows/Build.yml/badge.svg)](https://github.com/Konijima/pzpw-compiler/actions/workflows/Build.yml)
[![npm version](https://badge.fury.io/js/pzpw-compiler.svg)](https://badge.fury.io/js/pzpw-compiler)


[NPM](https://www.npmjs.com/search?q=pzpw) | [PZPW](https://github.com/Konijima/pzpw) | [Template](https://github.com/Konijima/pzpw-template) | [Donation](https://paypal.me/Konijima)
|---|---|---|---|


# Requirements

To install and use PZPW Compiler you need NodeJS and NPM.
- [Download NodeJS + NPM](https://nodejs.org/en/download/)
*Latest LTS Version: 16.17.0 (includes npm 8.15.0)*


# Installation

Install globally using npm:
```yml
npm install -g pzpw-compiler
```


# Commands

Compile all mods.
> *Optionally specify the mod ids to compile.*
```yml
pzpw-compiler mods
```

Compile mods into workshop.
> *Optionally specify the mod ids to compile.*
```yml
pzpw-compiler workshop
```

Get, set or unset game cachedir.
```yml
pzpw-compiler cachedir
```

Update PZPW Compiler.
```yml
pzpw-compiler update
```

Get help about commands.
```yml
pzpw-compiler help
```

Clean cachedir generated files.
```yml
pzpw-compiler clean
```

Print the current version.
```yml
pzpw-compiler version
```


> Apache License Version 2.0
> Copyright 2022 Konijima