Hugely based around the idea of Defold annotations, this repository aims to be the same, for typescript, but better.
It parses the official documentation from Defold and translates it to 2 typescript definition files.
Node 20.15.1 was used for this. Might not run with other versions
By default ts-defold provides their own types already on tsconfig.json. If you want to replace(or test) this repository i suggest you make a defold-ts project as normal, then after it's done, download the latest .zip Release and extract anywhere on yout project folder.
You will need to modify this line from tsconfig.json
"types": ["@typescript-to-lua/language-extensions", "@ts-defold/types"],
to
"types": ["@typescript-to-lua/language-extensions", "lua-types/5.1"],
Then extract index.d.ts on your @types folder (or anywhere, but this folder is already created by ts-defold) and dfld.ts on your src/modules folder (or anywhere inside the src folder, but again this folder is already created by ts-defold)
Now you should be good to go.
These annotations can be used by anyone just by dragging the file to your project
- index.d.ts contains the Defold API, constants and functions
- dmsg.ts contains a useful
dmsgobject that can serve as a helper to avoid sending messages or to look up the documentation of something. dprop.ts also contains the propertyes of each module
Install Node, run npm install and then npm run start. The output will be on the api folder
If you find a typo in the annotations or outdated meta information, create an issue.
By default it uses Defold version 1.9.1 , you can change this by editing the src_new/settings.ts file. There are other useful conditionals there to remove information from the final build
- Use namespace specific constants to have specific parameter return values. Maybe enums?
- Test the code and table, table_array, table_map
- Expand table declarations from the official documentation
- Implement on a project