rollup-plugin-jspicl

rollup-plugin-jspicl

This plugin uses jspicl to convert your JavaScript into a PICO-8 cartridge with lua code.

Installation

npm install rollup-plugin-jspicl --save-dev

Related projects

jspicl - A Javascript to PICO-8 Lua transpiler

jspicl-mario-sample - Mario sample game using jspicl and rollup-plugin-jspicl

Usage

import jspicl from "rollup-plugin-jspicl";

export default {
  input: "src/game.js",
  output: {
    file: "build/game.p8",
    format: "es"
  },
  plugins: [
    buble(),
    jspicl()
  ]
})

Options

Property	Type	Default	Description
cartridgePath	string		Path to cartridge to load sprites, map, music and sfx from. Ideally this should point to the generated cartridge so you can edit the assets directly. However, this setting gives you the option to use a separate cartridge as the source for your assets.
includeBanner	bool	true	Adds a comment at the very top of the generated bundle with jspicl info.
jsOutput	string		Output generated javascript code to a file. Useful for debugging if used in combination with astexplorer.
luaOutput	string		Output generated lua code to a file.
showStats	bool	true	Display useful stats about the generated cartridge
pico	object		PICO-8 specific options. See table below for details.

PICO-8 Options

Property	Type	Default	Description
autoRun	bool	true	Start up PICO-8 when starting the build with npm start
customPicoPath	string		Path to PICO-8. If not specified the default path will be used.
pipeOutputToConsole	bool	false	When true, will output console.log calls to terminal.
reloadOnSave	bool	true	Automatically reload the cart when saving.

Versioning

This project uses semantic versioning

License

MIT