@ts-defold/types/README.md

TypeScript definitions for Defold

# Defold Types
<a href="https://www.npmjs.com/package/@ts-defold/type-gen"><img alt="npm install" src="https://img.shields.io/npm/dt/@ts-defold/types?color=%23CA0000&label=npm&logo=npm"></a>
<a href="https://discord.gg/eukcq5m"><img alt="Chat with us!" src="https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc&logo=discord&logoColor=white"></a>
> TypeScript definitions for [Defold](https://defold.com/)

## Installation

1. Get this package from npm

```bash
yarn add @ts-defold/types --dev
# or
npm install @ts-defold/types --save-dev 
```

2. Modify your `tsconfig.json`

```diff
{
  "compilerOptions": {
+    "types": ["@ts-defold/types"]
  }
}
```

### Shoutouts 📢
[@dasannikov](https://github.com/dasannikov) and [DefoldTypescript](https://github.com/dasannikov/DefoldTypeScript) for a starting point and inspiration
[TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua) for the awesome community and tools
[@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).
<p align="center" class="h4">
  TypeScript :heart: Defold
</p>