Skip to content

README.md

Latest commit

 

History

History
55 lines (35 loc) · 908 Bytes

README.md

File metadata and controls

55 lines (35 loc) · 908 Bytes
Raw

Publish Package

🤖 Godot to TypeScript

This CLI tool generates TypeScript types and helpers based on Godot's GDScript files.

Usage

Install

# local project
bun i godot2ts

# global
bun i -g godot2ts

Use

godot2ts --help

The default command with no arguments will scan the current working directory recursively for .gd files and will generate one typescript file with all gd scripts converted to typescript.

Important

This tool marks TypeScript as a peer-dependency and requires it to be available in node_modules at runtime.

Contributing

Install dependencies:

bun install

Create a build

bun run build

Run tests

bun run test

Format & Lint

bun run format