Skip to content
šŸ‘¾ PICO-8 dependency manager
Branch: master
Clone or download
Latest commit 363f6c6 Aug 27, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src updated readme and a help message Aug 27, 2016
.gitignore
.npmignore updated json and added npmignore Aug 19, 2016
.travis.yml initial commit Aug 16, 2016
README.md Update README.md Aug 27, 2016
getting-started.md Getting Started with p8 Aug 27, 2016
p8.json.md Update p8.json.md Aug 27, 2016
package.json

README.md

p8

Build Status NPM Version NPM Downloads

šŸ‘¾ PICO-8 dependency manager

NOTE: This project is still in a very early stage. Feel free to open issues or hmu on twitter :)

Why?

I got tired of copy-pasting code from carts and using PICO-8's built-in IDE pretty quickly. This tool lets you reuse local and remote lua/moonscript modules and streamlines the process of reloading your cartridges as you develop.

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

npm install -g p8

NOTE: I haven't done any cross-platform testing yet, so make sure you are on OSX and are running node.js v6. Additionally, if you want support for moonscript, be sure to install moonc

Setup

It's just a few steps to get up and running. Altogether, it should only take a couple minutes šŸ». If you want a detailed walkthrough...

ā€¢ Read Getting Started with p8 Ā»

If you just want to jump straight in, here's the gist of what you need to do:

p8 init                                               # creates and adds basic fields to p8.json
p8 add https://some/website/module-i-want-to-require  # add lua or moonscript dependencies
p8 add https://some/website/my-spritesheet.png        # add sprites (gfxDependencies)
p8 install                                            # creates a pico_modules folder and stores dependencies there
p8 start --watch                                      # builds + runs your cart. reloads whenever the entry-point is saved

NOTE: Run p8 help for more detailed information on usage for these commands.

You might also want to check out the example p8 project and get familiar with the fields used in p8.json. File an issue or reach out if you run into any difficulties.

Credits

p8 is heavily inspired by npm and, to a lesser extent, webpack

I also borrowed a lot from my prior art -- a similar tool called picomoon

You canā€™t perform that action at this time.