Excalibur Next.js (TypeScript) Starter

This is a barebones Excalibur game engine starter built using Next.js (v15) and React (v19). It's a great starting place to jumpstart building your game! This repo is a template and can be used to create your own repository in GitHub.

Check out our other samples while you build your game or ask us questions.

Get Started

• Using Node.js (18 LTS - minimum) and npm
• Run the npm install to install dependencies
• Run the npm run dev to run the development server to test out changes
  • Next.js will automatically handle turning the Typescript into Javascript and hosting the dev server.

Publishing

• Run npm run build to produce production bundles. Note Next.js has a variety of options/settings to familiarize yourself with, from server side rendering to static bundles.

Notes

When deploying an Excalibur app in a Next.js context, given the Next.js API and strong support for React Server Components, one should ensure a good familiarity with the basics of the Next.js docs if straying too far from this template. Remember, this a barebones example, and Excalibur depends on client side APIs to run correctly.

Happy coding!