gmod-types
v0.4.1
Published
Intended for use with https://typescripttolua.github.io
Downloads
3
Readme
Typescript Declarations for Gmod
Intended for use with https://typescripttolua.github.io
What's new
- Updated to use new Facepunch wiki as source
- Updated to latest tstl version (requires 0.38.0 or higher)
- Types can now be augmented using data based transformers
- If you want to help improve the declarations make a PR for
src/transformer/modfications.json
- If you want to help improve the declarations make a PR for
TODO
- create template/example project
Usage
npm install gmod-types
- modify the tsconfig, add the declaration files to your
types
ortypeRoots
- use
"skipLibCheck": true,
in yourtsconfig.json
if you get duplicate identifier errors.
Development
- Clone
npm install
npm run build
to build the projectnpm run generate
to generate declarations
Program structure
- Scrapper
- Fetch wiki data
- Conversion of wiki xml to Wiki Objects
- Transformer
- Transforms extracted wiki objects to Typed Objects
- Printer
- Print the typed objects to
out/declarations.ts
- Print the typed objects to