Suggest Change / Typo

KorGE Targets Web (JS)

This target allows you to publish applications and games on any website. Making it available to anyone with a browser or a mobile phone.

This target works on any web browser supporting WebGL and WebAudio for sound, that is almost modern web browser nowadays.

Features fast compilation time, small output size, fast startup time and widely array of supported of devices with a single target.

Table of contents:

Executing

To compile, start an http-server and open a browser, use the gradle task:

./gradlew jsRun

Packaging

./gradlew jsBrowserDistribution # Outputs to /build/distributions

You can use any HTTP server to serve the files in your browser. For example using http-server: npm -g install http-server and then hs build/distributions. Or using live-server: npm -g install live-server and then live-server build/distributions. Or using Python3: change directory to build/distributions and then python -m http.server.

You can also use ./gradlew -t jsBrowserDistribution to continuously build the JS sources and run hs build/distributions in another terminal. Here you can find a testJs.sh script doing exactly this for convenience.

You can run your tests using Node.JS by calling jsTest or in a headless chrome with jsTestChrome.

Application Configuration

  • The Application Icon would be rendered as a favicon.ico.
  • The Application Title as the <title> tag.

Recommendations: runBlocking

Remember that the JS and the Common target doesn’t support blocking calls neither the runBlocking construct. So when dealing with I/O you have to mark your functions as suspend fun. Fortunately Korlibs are designed to be asynchronous, and reading resources is already suspending. So you only have to propagate the suspend modifier when required and you are mostly safe here.