README.md

GDevelop JavaScript Platform (HTML5 game engine)

GDevelop JavaScript Platform (GDJS) is the game engine for making HTML5/Javascript based games with GDevelop.

📚 Game developer, searching for the documentation? Go to the GDJS Runtime (game engine) documentation.

1) Installation 💻

To do changes in the game engine or create extensions, install the development version (click here to learn more).

2) Development 🤓

GDJS is composed of two parts:

• the JavaScript game engine (Runtime folder), called GDJS Runtime.
• the C++ part exposing GDJS to GDevelop IDE (GDJS folder), including the Exporter and classes doing transpilation from events to JavaScript, called GDJS Platform.

GDJS Runtime (game engine)

The game engine is in the Runtime folder. If you want to work on the engine directly, follow the GDevelop 5 README about the development of the game engine.

• To use the game engine, you can look into the GDJS Runtime (game engine) documentation.

• To run tests for the game engine, go to GDJS/tests, run npm install and npm test. More information in the README for the tests.

• To launch type checking with TypeScript, run npm install and npm run check-types in GDJS folder.

GDJS Platform (exporters, code generation...)

Check the GDJS Platform documentation or the full GDevelop developers documentation.

3) How to contribute 😎

Any contribution is welcome! Whether you want to submit a bug report, a feature request or any pull request to add a feature, do not hesitate to get in touch.

• Check the roadmap for ideas and features planned.

• Follow the Development section of the README to set up GDevelop and start modifying either the editor or the game engine/extensions.

• To submit your changes, you have first to create a Fork on GitHub (use the Fork button on the top right), then create a Pull Request.

License

GDJS is distributed under the MIT license: see LICENSE.md for more information.