Skip to content

Getting Started

Download GodotJS

Choose your platform and preferences to download the latest GodotJS release:

Note: The Godot.app isn't signed for MacOS you need to allow to open it.

Manual Installation

If you prefer to browse all releases manually, visit the GitHub Releases page.

Installation Instructions

After downloading:

  1. Extract the downloaded zip file
  2. Rename the executable based on your OS:
    • Linux: godot.linuxbsd.editor.x86_64 → godot
    • macOS: No rename required
    • Windows: godot.windows.editor.x86_64.exe → godot.exe
  3. Add Godot to your PATH
  4. Test the installation by running godot --version in your terminal

JS Engine Comparison

Engine Performance Memory Usage Platform Support Recommended For
V8 High Higher Desktop Development & Production
QuickJS Medium Lower All platforms Mobile & Embedded
JavaScriptCore High Medium macOS/iOS Apple platforms
Browser High Lower Web Web

Target Types

  • Editor: Full Godot editor with GodotJS support
  • Template: Export templates for building your games
  • Debug: Debug versions with additional logging and debugging features

Create a new project

Automatically with godot-ts

  1. Run npx -y @godot-js/godot-ts init (new project will be crated at your current terminal path)
  2. Follow the prompts
  3. Run cd <your-project>
  4. Run npm i
  5. Run npm run dev - this will enable typescript watch mode and opens the editor
  6. Inside the editor install preset files via Project > Tools > GodotJS > Install Preset files
  7. Click OK to confirm a list of files will be generated in the project.
  8. Attach the example.ts script to a node and run the project

Manually

  1. Run godot -p and create a new project
  2. Inside the editor install preset files via Project > Tools > GodotJS > Install Preset files
  3. Click OK to confirm a list of files will be generated in the project.
  4. Run cd <your-project>
  5. Run npm i
  6. Run npx tsc to compile the typescript files

Install Preset Files

Install Presets

Prompt

Create Scripts

To create new scripts, press select GodotJSScript as language:

Select Language

Use the Node: Node.Ts template:

Create a Script

Open the project folder in you IDE, you should see full TypeScript support!

Type Hint

Compile TypeScript Sources without godot-ts

Before your scripts runnable in Godot, run tsc to compile typescript sources into javascript.

npx tsc

# or watch if you want
npx tsc -w

Also, you can simply click the tool button on GodotJS bottom panel in the godot editor. It'll do the same thing for you.

TSC Watch