Skip to content
/ plugin-template Public template

a project template to create your own plugin

License

Notifications You must be signed in to change notification settings

melonjs/plugin-template

Repository files navigation

melonJS Plugin Template

melonJS Logo

License: MIT

a plugin project template for melonjs using rollup.

Usage

Install all required dependencies :

$ [sudo] npm install

Replace occurences of plugin-template to match with your plugin name in the package.json file

Start implementing your plugin using the provided empty plugin under /src/index.js

Build your plugin by running:

$ npm run build

The generated files will be available under the dist directory :

  • plugin-template.js (as per the default name in the package.json)
  • plugin-template.d.ts (typings for the plugin)

For more information about plugin and how to patch method, see our documentation here.

Questions, need help ?

If you need technical support, you can contact us through the following channels :

  • Forums: with melonJS 2 we moved to a new discourse forum, but we can still also find the previous one here
  • Chat: come and chat with us on discord
  • we tried to keep our wikipage up-to-date with useful links, tutorials, and anything related melonJS.