<p align="center"> <picture> <source media="(min-width: 720px)" srcset="docs/header.svg"> <img src="docs/header-mobile.svg" width="900" height="330" alt="GodotJS Logo"> </picture> </p>

GodotJS

<p align="center"> TypeScript/JavaScript Support for Godot 4.x by leveraging the high-performance capabilities of V8 to bring the delightful development experience of TypeScript into Godot. </p> <p align="center"> <a href="https://github.com/godotjs/GodotJS/actions"><img src="https://github.com/godotjs/GodotJS/actions/workflows/runner.yml/badge.svg?branch=main" alt="Build Status"></a> <a href="https://github.com/godotjs/GodotJS/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License"></a> </p>

Documentation

For full documentation, visit godotjs.github.io.

---

See Breaking Changes if upgrading from old versions.

[!NOTE] The core functionality is implemented and essentially usable but still under testing.

Features

• [x] Godot ScriptLanguage integration
• [x] Debug with Chrome/VSCode (with v8) and Safari (with JavaScriptCore)
• [x] REPL in Editor
• [x] Hot-reloading
• [x] Support for multiple javascript engines (v8, quickjs, quickjs-ng, JavaScriptCore, the host Browser JS)
• [x] Worker threads (limited support) (experimental)
• [x] Asynchronously loaded modules (limited support) (temporarily only available in v8.impl, quickjs.impl)

Examples

For more information on how to use GodotJS in a project, check out GodotJSExample for examples written in typescript.
And, don't forget to run npm install and npx tsc before opening the example project.