![\"Chat](\"https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc&logo=discord&logoColor=white\")
\n![\"npm](\"https://img.shields.io/npm/dt/@ts-defold/type-gen?color=%23CA0000&label=npm&logo=npm\")
\n> TypeScript type generator for Defold\n\ntype-gen is a TypeScript declarations generator for the [Defold](https://github.com/defold/defold) game engine.\n- types are parsed generated from the [offical documentation](https://defold.com/ref/stable/go/)\n- types will avoid `any` if they can\n- vmath.* types can all be used with number operators through [Intersection Types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html)\n - you will need to decorate with an aditional cast upon assignment, but a fair tradeoff vs. vector math function helpers\n ```ts\n function on_update(this:{pos: vmath.vector3, dir: vmath.vector3}, dt: number) {\n const speed = 331;\n this.pos = this.pos + this.dir * speed * dt as vmath.vector3;\n }\n ```\n- generated typdoc commnets from lua documentation\n- fully generated with no need to manually intervine\n\n## Usage: Install & {}\ntype-gen was made to generate types for [@ts-defold/types](https://github.com/ts-defold/types) and is included as a dev dependency.\nIf you are simply wanting typescipt types for your Defold project **@ts-defold/types** is your best bet.\n> `npm install -D @ts-defold/types`\n\nIf you would like to generate your own types, hack on this project, or contribute in any way, i would suggest you try:\n```sh\ngit clone https://github.com/ts-defold/type-gen.git\ncd type-gen\nnpm install \nnpm run build\n```\n\nAlternatively, if you would like to just generate your types without the dependency then simply:\n```sh\nnpx @ts-defold/type-gen\n#or\nnpx @ts-defold/type-gen -- defold.d.ts --channel stable --api latest\n```\n\n@ts-defold/type-gen can optionally take in arguments:\n- **[defold.d.ts]** path to generated output file\n- **--channel** [stable | beta | alpha]\n- **--api** [latest | 1.2.xxx]\n\nIf being used in a project locked to a specific release channel or version of defold you may add configuration settings in your `package.json` instead:\n```json\n\"ts-defold\": {\n \"channel\": \"stable\",\n \"output\": \"index.d.ts\"\n},\n```\n\n### Shoutouts 📢\n[@dasannikov](https://github.com/dasannikov) and [DefoldTypescript](https://github.com/dasannikov/DefoldTypeScript) for a starting point and inspiration\n[TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua) for the awesome community and tools\n[@hazzard993](https://github.com/hazzard993), [@ark120202](https://github.com/ark120202), [@Perryvw](https://github.com/Perryvw) and all the fine folks over on the [tstl discord server](https://discord.gg/BWAq58Y).\n\n TypeScript :heart: Defold\n
\n","readmeFilename":"README.md"}