Question: Can you use TypeScript with Love2D?


Love2D is a framework for making 2D games in the Lua programming language. TypeScript, on the other hand, is a typed superset of JavaScript that compiles to plain JavaScript. While Love2D does not natively support TypeScript as it is not a JavaScript-based engine, it is possible to integrate TypeScript into your development workflow by using technologies that compile or transpile to Lua.

One option is to use TypeScriptToLua (, which is a TypeScript plugin that transpiles TypeScript code into Lua. This allows you to write your game's code in TypeScript and then compile it to Lua code that can be run within the Love2D framework.

Here's an example of how you might set up a project using TypeScriptToLua:

  1. Install TypeScriptToLua via npm:
npm install -g typescript-to-lua
  1. Create a tsconfig.json that includes TypeScriptToLua settings:
{ "compilerOptions": { "target": "esnext", "lib": ["esnext"], "types": [], "strict": true, "rootDir": "./src", "outDir": "./out", "luaTarget": "5.1", "luaLibImport": "inline", "sourceMap": true }, "tstl": { "luaPlugins": [] }, "include": [ "src/**/*.ts" ] }
  1. Write your game code in TypeScript, saving files with a .ts extension in the src directory.

  2. Compile your TypeScript files to Lua using the TypeScriptToLua compiler:

  1. Run your Love2D game as usual with the generated Lua files.

Keep in mind that when writing TypeScript for a Love2D project, you will not have access to TypeScript definitions for Love2D's API out of the box. You'll either need to create your own declaration files to describe Love2D's API in TypeScript terms or find a community-made declaration file if one exists.

Also note that because TypeScript is designed to work well with JavaScript ecosystems, some TypeScript features or libraries may not be compatible with the Lua ecosystem or the TypeScriptToLua transpiler, so you should test and verify individual features and libraries within your project's context.

Was this content helpful?

White Paper

Free System Design on AWS E-Book

Download this early release of O'Reilly's latest cloud infrastructure e-book: System Design on AWS.

Free System Design on AWS E-Book

Start building today

Dragonfly is fully compatible with the Redis ecosystem and requires no code changes to implement.