https://github.com/thinknathan/tsd-xmath-types
Types for @thejustinwalsh's xmath, a Defold Math eXtention Library that avoids allocations
https://github.com/thinknathan/tsd-xmath-types
defold defold-game-engine gamedev tstl typescript typescript-definitions typescript-to-lua
Last synced: 4 months ago
JSON representation
Types for @thejustinwalsh's xmath, a Defold Math eXtention Library that avoids allocations
- Host: GitHub
- URL: https://github.com/thinknathan/tsd-xmath-types
- Owner: thinknathan
- License: mit
- Archived: true
- Created: 2023-06-27T01:47:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-06T01:48:17.000Z (over 1 year ago)
- Last Synced: 2024-10-25T09:48:29.971Z (7 months ago)
- Topics: defold, defold-game-engine, gamedev, tstl, typescript, typescript-definitions, typescript-to-lua
- Homepage:
- Size: 104 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-xmath
TypeScript types for thejustinwalsh's [defold-xmath](https://github.com/thejustinwalsh/defold-xmath), a Defold Math eXtention Library that avoids allocations.
For use with [TS-Defold](https://github.com/ts-defold) and [TypeScriptToLua](https://github.com/TypeScriptToLua).
The documentation comments are copied from Defold's vmath library with some modifications; they may not be 100% accurate to xmath's implementation.
## Installation
1. Create a [TS-Defold](https://github.com/ts-defold) project
2. Add [defold-xmath](https://github.com/thejustinwalsh/defold-xmath) to your Defold project
3. Import these types
```bash
yarn add git+https://[email protected]/thinknathan/tsd-xmath-types.git#^1.0.0 -D
# or
npm install git+https://[email protected]/thinknathan/tsd-xmath-types.git#^1.0.0 --save-dev
```
4. Add `tsd-xmath` to `types` in `tsconfig.json`
```diff
{
"compilerOptions": {
"types": [
+ "tsd-xmath",
],
}
}
```
5. Add `node_modules/@types` to `typeRoots` in `tsconfig.json` if it's not already there
```diff
{
"compilerOptions": {
"typeRoots": [
+ "node_modules/@types",
],
}
}
```
TypeScript :heart: Defold
## License
MIT
Comments are adapted from [Defold's](https://github.com/defold/) code comments.