Skip to content
This repository has been archived by the owner on Jan 26, 2024. It is now read-only.
/ tsd-boom-types Public archive

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

License

Notifications You must be signed in to change notification settings

thinknathan/tsd-boom-types

Repository files navigation

Boom Types

@types/tsd-boom

Chat with us!

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://git@github.com/thinknathan/tsd-boom-types.git#^1.0.0 -D
# or
npm install git+https://git@github.com/thinknathan/tsd-boom-types.git#^1.0.0 --save-dev
  1. Add tsd-boom to types in tsconfig.json
{
	"compilerOptions": {
		"types": [
+			"tsd-boom",
		],
	}
}
  1. 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