# p8

> 👾 PICO-8 dependency manager

Latest version **1.0.0** (published 2021-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install p8
pnpm add p8
yarn add p8
bun add p8
```

Provides the command `p8`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-05-31 |
| First published | 2016-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 116.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Josiah Savary |
| Maintainers | josiahsavary, jozanza |
| Keywords | pico8, pico-8, lua, moonscript, carts |

## Links

- npm: https://www.npmjs.com/package/p8
- Repository: https://github.com/jozanza/p8
- Homepage: https://github.com/jozanza/p8#readme
- Issues: https://github.com/jozanza/p8/issues
- npm.io page: https://npm.io/package/p8

## Dependencies (4)

- [moonc](https://npm.io/package/moonc.md) ^1.1.5
- [yargs](https://npm.io/package/yargs.md) ^17.0.1
- [get-pixels](https://npm.io/package/get-pixels.md) ^3.3.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0

## Recent versions

- 1.0.0 (latest) — 2021-05-31
- 0.0.6 — 2016-08-27
- 0.0.5 — 2016-08-21
- 0.0.4 — 2016-08-20
- 0.0.3 — 2016-08-19
- 0.0.2 — 2016-08-19
- 0.0.1 — 2016-08-19

## README

# p8

<!-- [![Build Status](https://api.travis-ci.org/jozanza/p8.svg?branch=master)](https://travis-ci.org/jozanza/p8) -->
[![NPM Version](https://img.shields.io/npm/v/p8.svg?style=flat)](https://www.npmjs.org/package/p8)
[![NPM Downloads](https://img.shields.io/npm/dm/p8.svg?style=flat)](https://www.npmjs.org/package/p8)

👾 PICO-8 dependency manager

Import lua/moonscript modules, spritesheets, and automatically reload your carts as you code.

<br />

## Features:

- Share **code** and **sprites** (via github or any file host)
- Use **`require()`** to use modules in your own carts
- Code in **any IDE** you want
- **Auto-reload** carts on save

<br />

## Installation

### Download the executable

You can grab the executable for your platform from [**releases page** &rarr;](./releases)

<sup>- On macOS or linux, you may want to copy the executable into `/usr/bin`.</sup><br />
<sup>- On windows, you may want to add the executable to your PATH.</sup>

### NPM

Or you can use good old npm

```sh
npm i -g p8
```

<br />

## Getting Started

You can be up-and-running in a few quick steps.

### 1. Initialize your project

Create and/or adds basic fields to p8.json.

```
p8 init
```

### 2. Add Dependencies

Add .lua, .moon, .png, .jpg, or .gif files.

```
p8 add [file|url...]
```

### 3. Run your cartridge

Use the `--watch` flag to automatically reload whenever the entry-point is saved. This command will automatically install and build if you haven't already.

```
p8 run
```

<br />

## Usage

```
Usage: p8 <command> [options]

Commands:
  p8 add [file|url...]  add modules as "dependencies" or "gfxDependencies" in p8.json.
  p8 build              outputs a cart (.p8 file)
  p8 init               initialize the project
  p8 install            install dependencies listed in p8.json to ./pico_modules
  p8 run                runs a .p8 cartridge (PICO-8 switches can be passed after a trailing --)
Options:
  --version  Show version number
  --help     Show help
```

> **If you want a detailed walkthrough, read [Getting Started with p8 &rarr;](./getting-started.md).<br />**

> **If you want more examples, [check out the examples &rarr;](./examples)**

---
_Source: https://npm.io/package/p8 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._