phaser3-docs Phaser 3 Documentation and TypeScript

Youcaneither:

Gotohttps://photonstorm.github.io/phaser3-docs/index.htmltoreadthedocsonline.Usethedrop-downmenusatthetoptonavigatethenamespaces,classesandGameObjectslists.

Or,youcancheckoutthisrepositoryandthenreadthedocumentationbypointingyourbrowsertothelocaldocs/folder.AgainusingtheClassesandNamespaceslinksatthetopofthepagetonavigate.

Youcanalsogeneratenewdocslocallybyrunningnpmrungenandwaiting(itmaytakeuptoanhourtogeneratethedocs).SeeGeneratingtheDocsLocallybelowformoreinstructions.

TheTypeScriptdefshavebeenmovedtothemainPhaserrepository.

Phaserusesthepopularjsdoc,whichmeansthedocumentationitselfiswritteninthesourcecodeinthePhaserrepository.Inordertoregeneratethedocs,you'llneedtoclonethatrepositoryanditmustbeinafoldernamedphaserintheparentdirectory.

Thenrunnpminstalltoinstalldependencies,andfinallyrunnpmrungen.Thegenerateddocswillbeinanewdirectorycalledout/.Doubleclickonout/index.htmltobrowsethegenerateddocumentation.