Files
GDevelop/GDJS/docs

GDJS Documentation

📚 Read the documentation online: GDJS Runtime (game engine) documentation or GDJS Platform documentation for the IDE.

How to generate the documentation

  • To generate the GDJS Runtime (game engine) documentation:

    cd <GDevelop repository>/GDJS
    npm install
    npm run generate-doc
    

    Output will be in <GDevelop repository>/docs/GDJS Documentation.

  • To generate the GDJS Platform documentation for the IDE, install Doxygen. Then:

    cd <GDevelop repository>/GDJS/docs
    doxygen
    

    Output will be in <GDevelop repository>/docs/GDJS Runtime Documentation.