https://github.com/melonjs/plugin-template

a project template to create your own plugin
https://github.com/melonjs/plugin-template

canvas game-development html5 melonjs plugin rollup template webgl

Last synced: 5 months ago
JSON representation

a project template to create your own plugin

• Host: GitHub
• URL: https://github.com/melonjs/plugin-template
• Owner: melonjs
• License: mit
• Created: 2023-04-01T01:11:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-13T01:51:34.000Z (over 2 years ago)
• Last Synced: 2025-10-13T11:12:02.880Z (5 months ago)
• Topics: canvas, game-development, html5, melonjs, plugin, rollup, template, webgl
• Language: JavaScript
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# melonJS Plugin Template

![melonJS Logo](https://github.com/melonjs/melonJS/raw/master/media/Banner/Banner%20-%20Billboard%20-%20Original%20Logo%20-%20horizontal.png)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/melonjs/es6-boilerplate/blob/master/LICENSE)

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](package.json) file

Start implementing your plugin using the provided [empty plugin](src/index.js) 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](https://melonjs.github.io/melonJS/docs/melonjs/plugin.html).

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](https://melonjs.discourse.group), but we can still also find the previous one [here](http://www.html5gamedevs.com/forum/32-melonjs/)

* Chat: come and chat with us on [discord](https://discord.gg/aur7JMk)

* we tried to keep our [wikipage](https://github.com/melonjs/melonJS/wiki) up-to-date with useful links, tutorials, and anything related melonJS.