Thank you for your interest in contributing to melonJS !
Please read our Code of Conduct to keep our community approachable and respectable.
If this is your first time contributing to an open source project on GitHub, please have a look at this free tutorial.
The only things you need to start developing melonJS is Node.js and pnpm. melonJS uses Corepack to manage the package manager version. Follow the instructions to install pnpm using Corepack. Run pnpm install to install third party dependencies.
You can start development mode by running pnpm dev which will build melonJS and the docs on every file change and start a Vite dev server with the examples so you can test out your changes in real time.
Build the melonJS source by running:
pnpm build
The generated files will be available under the build directory:
index.js: melonJS ESM bundleindex.js.map: source map of the bundle*.d.ts: TS declaration files*.d.ts.map: TS declaration source maps
To run the melonJS test suite use the following:
pnpm test
Last but not least, if you really want to contribute, but not sure how, you can always check our discussions list to get some idea on where to start.
Similarly, you can build your own copy of the docs locally by running :
$ pnpm doc
The documentation will be generated under the docs directory, and can be accessed by opening index.html in your web browser.
If you need technical support, you can contact us through the following channels :
- Forums: you can find us here on the html5gamedevs forum
- Chat: come and chat with us on discord
- Wiki: we tried to keep our wikipage up-to-date with useful links, tutorials, and anything related melonJS.
Support the development of melonJS by becoming a sponsor. Get your logo in our README with a link to your site or become a backer and get your name in the BACKERS list. Any level of support is really appreciated and goes a long way !
