https://github.com/thinknathan/tsd-boom-types
Types for @britzl's boom, a game framework built on top of Defold
https://github.com/thinknathan/tsd-boom-types
boom defold defold-boom defold-game-engine gamedev lua tstl typescript typescript-definitions typescript-to-lua
Last synced: 4 months ago
JSON representation
Types for @britzl's boom, a game framework built on top of Defold
- Host: GitHub
- URL: https://github.com/thinknathan/tsd-boom-types
- Owner: thinknathan
- License: mit
- Archived: true
- Created: 2023-06-20T00:15:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-06T01:48:11.000Z (over 1 year ago)
- Last Synced: 2024-10-25T09:48:26.293Z (7 months ago)
- Topics: boom, defold, defold-boom, defold-game-engine, gamedev, lua, tstl, typescript, typescript-definitions, typescript-to-lua
- Homepage:
- Size: 134 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @types/tsd-boom
TypeScript types for britzl's [boom](https://github.com/britzl/boom/), a game framework built on top of [Defold](https://defold.com/).
For use with [TS-Defold](https://github.com/ts-defold) and [TypeScriptToLua](https://github.com/TypeScriptToLua).
## Installation
1. Create a [TS-Defold](https://github.com/ts-defold) project
2. Add [boom](https://github.com/britzl/boom/) to your Defold project
3. Import these types
```bash
yarn add git+https://[email protected]/thinknathan/tsd-boom-types.git#^1.0.0 -D
# or
npm install git+https://[email protected]/thinknathan/tsd-boom-types.git#^1.0.0 --save-dev
```
4. Add `tsd-boom` to `types` in `tsconfig.json`
```diff
{
"compilerOptions": {
"types": [
+ "tsd-boom",
],
}
}
```
5. Add `node_modules/@types` to `typeRoots` in `tsconfig.json` if it's not already there
```diff
{
"compilerOptions": {
"typeRoots": [
+ "node_modules/@types",
],
}
}
```
## Usage
You can now import `boom` in your TypeScript like this:
```ts
import { boom } from 'boom.boom';
```
TypeScript :heart: Defold
## License
MIT