Build & Bundlers

To get started, first install Excalibur through npm (TypeScript typings are best supported in npm):

bash
npm install excalibur

bash
npm install excalibur

TypeScript Configuration

In a TypeScript (or modern JavaScript) project, you can reference Excalibur with the ES6 import style syntax:

js
// Excalibur is loaded into the ex global namespace
import * as ex from 'excalibur';

js
// Excalibur is loaded into the ex global namespace
import * as ex from 'excalibur';

js
// Excalibur is loaded into the ex global namespace
import { Actor, Engine } from 'excalibur';

js
// Excalibur is loaded into the ex global namespace
import { Actor, Engine } from 'excalibur';

To support tree-shaking, you should use named imports:

js
import { Actor } from 'excalibur';

js
import { Actor } from 'excalibur';

warning

Excalibur's tree-shaking optimization is not fully optimized yet--likely you'll end up importing everything at the moment, but this is slowly getting better.

TSConfig

We have a base recommended tsconfig.json that the TypeScript compiler uses as configuration. In this example we assume all the source is in a ./src/ directory.

json
{
  "include": ["src/**/*"],
  "compilerOptions": {
    /* Basic Options */
    "target": "es2015" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
    "module": "es2015" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
    /* Specify library files to be included in the compilation. */
    "lib": ["dom", "es5", "es2015.Proxy", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015"],
    /* Strict Type-Checking Options */
    "strict": true /* Enable all strict type-checking options. */,
    /* Module Resolution Options */
    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
    "baseUrl": "./src" /* Base directory to resolve non-absolute module names. */,
    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
    /* Advanced Options */
    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
  }
}

json
{
  "include": ["src/**/*"],
  "compilerOptions": {
    /* Basic Options */
    "target": "es2015" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
    "module": "es2015" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
    /* Specify library files to be included in the compilation. */
    "lib": ["dom", "es5", "es2015.Proxy", "es2015.promise", "es2015.collection", "es2015.iterable", "es2015"],
    /* Strict Type-Checking Options */
    "strict": true /* Enable all strict type-checking options. */,
    /* Module Resolution Options */
    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
    "baseUrl": "./src" /* Base directory to resolve non-absolute module names. */,
    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
    /* Advanced Options */
    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
  }
}

In a module loader system, such as Webpack or Parcel, it will automatically bundle Excalibur. See the webpack example repo or parcel repo

Parcel

Parcel is by far the easiest way to get a bundler up and running with Excalibur. We recommend looking at the template.

warning

Adding an import "regenerator-runtime/runtime"; in your entry file is needed to force Parcel to understand async/await inside Excalibur.

Using npm to install Parcel:

bash
npm install parcel-bundler --save-dev

bash
npm install parcel-bundler --save-dev

Using npm to install Excalibur and TypeScript:

bash
npm install excalibur typescript

bash
npm install excalibur typescript

Configure your tsconfig.json:

bash
tsc --init

bash
tsc --init

The suggested file structure is as follows:

/project_folder
    /node_modules
        ...
    /src
        index.html
        index.ts
    
    package-lock.json
    package.json
    tsconfig.json

/project_folder
    /node_modules
        ...
    /src
        index.html
        index.ts
    
    package-lock.json
    package.json
    tsconfig.json

Create your game script:

typescript
// ./src/index.ts
const game = new Engine({
  width: 600,
  height: 400
});
game.start();

typescript
// ./src/index.ts
const game = new Engine({
  width: 600,
  height: 400
});
game.start();

Include the TypeScript file in your html:

html
<html>
  <head></head>
  <body>
    <script src="./index.ts"></script>
  </body>
</html>

html
<html>
  <head></head>
  <body>
    <script src="./index.ts"></script>
  </body>
</html>

Build and run with Parcel!

bash
npx parcel src/index.html --no-autoinstall

bash
npx parcel src/index.html --no-autoinstall

Webpack

Webpack is the battleship solution, and if you need a lot of control over your build process, this might be the way to go.

warning

Configuring Webpack is not for the faint of heart, we recommend thoroughly reading webpack's documentation on how to understand and configure webpack.

Our Webpack template is a good starting point.

Deno

Deno is a runtime for JavaScript and TypeScript and much more than a bundler, but we put this section here since you'll be doing a lot of bundling :).

For Excalibur to work in a Deno environment, use a Content Delivery Network (CDN) for making Node.js packages compatible with Deno. Two popular ones are esm.sh and skypack.dev.

To keep it simple, we use esm.sh in the following examples, but feel free to make your own choice - at the time of writing the procedure for esm.sh and skypack.dev is nearly identical (for a difference, see the section Types and IntelliSense).

Importing within an HTML file

Sometimes, you just want to start hacking. You can do so by using Deno to get a bundled version of Excalibur and directly applying the module to your HTML.

Either esm.sh or skypack.dev should generate a bundle that works:

bash
deno bundle https://esm.sh/excalibur excalibur.bundle.js

bash
deno bundle https://esm.sh/excalibur excalibur.bundle.js

note

Learn more about the deno bundle command in the official docs.

Using as a native module works in Chrome without any extras:

html
<!-- index.html -->
<script type="module">
  import ex from './excalibur.bundle.js';
  const game = new ex.Engine();
  game.start();
</script>

html
<!-- index.html -->
<script type="module">
  import ex from './excalibur.bundle.js';
  const game = new ex.Engine();
  game.start();
</script>

note

Learn more about the type="module" attribute on MDN.

The drawback to this method is that it doesn't give you type annotations in your IDE, like the following method.

Importing into a JavaScript or TypeScript File

note

We have tested the following examples with version 0.26.0-alpha.264 of the excalibur package. We recommend you run at least that version for this to work. You can get the latest excalibur version on npm.

More likely, you will want to import Excalibur into a JavaScript or TypeScript file.

Since it goes very well with Deno, we use TypeScript in the following examples. We will have to set up our TypeScript compiler and pick our import syntax before we can make our bundle.

A custom tsconfig.json must be used with strict turned off and a few DOM libraries added:

json
// tsconfig.json
{
  "compilerOptions": {
    "strict": false,
    "lib": ["dom", "dom.iterable", "dom.asynciterable", "Deno.ns"]
  }
}

json
// tsconfig.json
{
  "compilerOptions": {
    "strict": false,
    "lib": ["dom", "dom.iterable", "dom.asynciterable", "Deno.ns"]
  }
}

After that, Excalibur can be imported. This can be done in one of two ways:

Recommended: Named Import

typescript
// index.ts
import { Engine } from 'https://esm.sh/excalibur@0.26.0-alpha.264';
const game = new Engine();
game.start();

typescript
// index.ts
import { Engine } from 'https://esm.sh/excalibur@0.26.0-alpha.264';
const game = new Engine();
game.start();

Alternative: Namespace Import

typescript
// index.ts
import * as ex from 'https://esm.sh/excalibur@0.26.0-alpha.264';
const game = new ex.Engine();
game.start();

typescript
// index.ts
import * as ex from 'https://esm.sh/excalibur@0.26.0-alpha.264';
const game = new ex.Engine();
game.start();

There are two main reasons:

We find named imports more expressive and explicit than the wildcard * syntax. It's easier for you and your collaborators to see what parts of the module are actually being used when they are all listed in the import statement.
They can help with tree shaking, as explained in this relatively beginner-friendly developers.google tutorial.

note

Tree shaking means removing unused code, reducing the size of your bundle so that your app can load faster for the end-user. This can be done by build tools such as Rollup and Webpack.

Both approaches work. You may have reasons for using namespace imports. We encourage you to research your options.

note

The official MDN documentation is a great place to start learning about modules and imports.

Bundling and Applying

Set up your tsconfig.json and your index.ts as described in the Importing into a JavaScript or TypeScript File section above. Then Deno should successfully bundle:

bash
deno bundle index.ts game.bundle.js --config tsconfig.json

bash
deno bundle index.ts game.bundle.js --config tsconfig.json

note

Learn more about the deno bundle command in the official Deno docs.

You can then apply it in your index.html with a regular script tag:

html
<script src="game.bundle.js"></script>

html
<script src="game.bundle.js"></script>

Types and IntelliSense

Screenshot demonstrating IntelliSense

To enable type annotations and IntelliSense in a Deno environment, you might need to install a special extension in your IDE, such as this one for VSCode: Deno extension by denoland.

Make sure to read the instructions of the extension. you might also need to install the Deno CLI and later initialize the extension in your IDE workspace.

warning

It may take a few seconds for IntelliSense to start working. Deno is resolving the import URLs and downloading the necessary files in the background.

If you're using skypack.dev, you might also need to add the ?dts query parameter to the package name. your import should read something like this:

typescript
import { Engine } from "https://cdn.skypack.dev/excalibur?dts

typescript
import { Engine } from "https://cdn.skypack.dev/excalibur?dts

Or, if you want to use a specific version:

typescript
import { Engine } from "https://cdn.skypack.dev/excalibur@0.26.0-alpha.264?dts

typescript
import { Engine } from "https://cdn.skypack.dev/excalibur@0.26.0-alpha.264?dts

note

Read more about TypeScript declarations in the official skypack.dev docs.

TypeScript Configuration​

TSConfig​

Parcel​

Webpack​

Deno​

Importing within an HTML file​

Importing into a JavaScript or TypeScript File​

Aside - Why do we recommend named imports over namespace imports?​

Bundling and Applying​

Types and IntelliSense​

TypeScript Configuration

TSConfig

Parcel

Webpack

Deno

Importing within an HTML file

Importing into a JavaScript or TypeScript File

Aside - Why do we recommend named imports over namespace imports?

Bundling and Applying

Types and IntelliSense