Phaser docs on Github

Recommended Posts

Hello. I recently visited this site and when I downloaded the Phaser Github repo, I found that it is not version 2.6.2 but it was version 3.

But ok, that  is not the worst problem. When I cloned the repo, the docs folder weren't downloaded. I also found that in that .eslintignore file, there was a line


which of course means, ignore the docs folder.

Also another strange thing is, when I cloned the repo, in my local repository of Phaser, the file .eslintignore didn't contain the line


which is what the hell.
Do I need to build Phaser or docs in order to have them. But I already run

npm install
npm run lint
npm run build

which only built Phaser. It didn't generate docs, what the hell.


Some tricks going on. How do i get the docs?

Also should I upgrade my Phaser 2.6 games to Phaser 3? Are they very different from each other?


Edited by spinnerbox

Share this post

Link to post
Share on other sites

Phaser 3 repo is at https://github.com/photonstorm/phaser

Phaser 3 Docs are at https://github.com/photonstorm/phaser3-docs

If you clone the repo, the docs are in the 'docs' folder.

eslintignore is nothing to do with docs. It's to do with what gets lint checked. However, there is no eslint file in the docs repo. There's also no 'npm build' command either,  so you were looking in a different repo.

Phaser 2 repo is at https://github.com/photonstorm/phaser-ce

Phaser 2 docs are in the docs folder of that repo.

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.