How does it work?

QGML compiles your file (along with all image assets that are referenced inside it) into a single .js file that you then load on your website.

Installation

$ npm i -g @qgml/cli

CLI Quick Start

Compiling

This will bundle your file into a .js file named <myFile>.js

$ qgml --source myFile

You can specify an output file name with the --output argument

$ qgml --source myFile --output myOutputFile.js
Serving

This will compile your file and then start a server on the specified port (default: 8000) where it will serve the game.

serve also offers hot-reloading, so, if you make a change to your file and save it, it should auto-reload in your browser without needing to stop the server.

note: it does not hot-reload assets, so, if you change an image file, you will have to restart the server.

$ qgml --source myFile --serve 8000

Learning QGML

In my opinion the best way to get the hang of QGML is to see it in action. So, feel free to look at the Examples