Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jozanza/p8
👾 PICO-8 dependency manager
https://github.com/jozanza/p8
pico-8
Last synced: 6 days ago
JSON representation
👾 PICO-8 dependency manager
- Host: GitHub
- URL: https://github.com/jozanza/p8
- Owner: jozanza
- Created: 2016-08-16T23:24:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T03:18:52.000Z (over 1 year ago)
- Last Synced: 2024-09-15T17:25:46.731Z (about 2 months ago)
- Topics: pico-8
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/p8
- Size: 261 KB
- Stars: 45
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-PICO-8 - p8 - A dependency manager and build tool. Lets you share code/sprites, `require()` dependencies, and auto-reload carts on save. Works with any external code editor and supports [MoonScript](https://moonscript.org/). (Uncategorized / Uncategorized)
README
# p8
[](https://www.npmjs.org/package/p8)
[](https://www.npmjs.org/package/p8)
👾 PICO-8 dependency manager
Import lua/moonscript modules, spritesheets, and automatically reload your carts as you code.
## 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
## Installation
### Download the executable
You can grab the executable for your platform from [**releases page** →](https://github.com/jozanza/p8/releases)
- On macOS or linux, you may want to copy the executable into `/usr/bin`.
- On windows, you may want to add the executable to your PATH.
### NPM
Or you can use good old npm
```sh
npm i -g p8
```
## 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
```
## Usage
```
Usage: p8 [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 →](./getting-started.md).
**
> **If you want more examples, [check out the examples →](./examples)**