1.0.2 • Published 6 months ago
kaplay-hi-plugin v1.0.2
KAPLAY Plugin Template
A minimal and clean KAPLAY.js plugin template for creating and publishing plugins.
If you're reading the
kaplay-hi-plugin
on NPM, this is a demo plugin that adds ahi()
function to log "hi". If you want to create your plugin, check the template.
Download template
You can download the template using "Download ZIP" option in GitHub or
by using git clone
:
git clone https://github.com/kaplayjs/kaplay-plugin-template
Then navigate to the template folder and install dependencies:
cd kaplay-plugin-template
npm install
Creating your plugin
Your plugin code is in src/plugin.js
. To understand more about KAPLAY plugins,
read this guide.
Testing and building
test/game.js
file imports your plugin that you can test with a KAPLAY game.
You can then build your masterpiece with:
npm run build
After selecting a name, you can publish it using:
npm publish
We recommend adding kaplay- before plugin names. For example:
kaplay-matter
kaplay-box2d
kaplay-poki
etc.