thinknathan / tsd-boom-types

Types for @britzl's boom, a game framework built on top of Defold

@types/tsd-boom

TypeScript types for britzl's boom, a game framework built on top of Defold.

For use with TS-Defold and TypeScriptToLua.

Installation

1. Create a TS-Defold project
2. Add boom to your Defold project
3. Import these types

yarn add git+https://[e-mail]/thinknathan/tsd-boom-types.git#^1.0.0 -D
# or
npm install git+https://[e-mail]/thinknathan/tsd-boom-types.git#^1.0.0 --save-dev

4. Add tsd-boom to types in tsconfig.json

{
	"compilerOptions": {
		"types": [
+			"tsd-boom",
		],
	}
}

5. Add node_modules/@types to typeRoots in tsconfig.json if it's not already there

{
	"compilerOptions": {
		"typeRoots": [
+			"node_modules/@types",
		],
	}
}

Usage

You can now import boom in your TypeScript like this:

import { boom } from 'boom.boom';

TypeScript ❤️ Defold

License

MIT