karlossg / phaser3-docs

Phaser 3 Documentation and TypeScript Defs

Phaser 3 API Documentation

You can either:

1. Go to https://photonstorm.github.io/phaser3-docs/index.html to read the docs online. Use the drop-down menus at the top to navigate the name spaces, classes and Game Objects lists.

2. Or, you can checkout this repository and then read the documentation by pointing your browser to the local docs/ folder. Again using the Classes and Namespaces links at the top of the page to navigate.

You can also generate new docs locally by running npm run gen (and waiting a long time, it takes over an hour to build)

TypeScript Definitions

The TypeScript defs can be found in the typescript folder.

They are automatically generated from the jsdoc comments in the Phaser source code. If you wish to help refine them then you must edit the Phaser jsdoc blocks directly.

Please do not edit the defs file.

We will not accept any PRs for the defs file itself. If you wish to help correct errors then do so in the Phaser source jsdoc blocks.

TypeScript Defs Generation Tool

The defs generation tool is called tsgen and it's written in TypeScript. Build it by running npm run build-tsgen. This will compile the parser locally.

You can then run npm run tsgen to build the actual defs. Once the parser is built you only need use this command. Use it to re-generate the defs if you have modified the Phaser source code.

There is also a test script available: npm run test-ts which will compile a test project and output any compilation errors to output.txt.