kittykatattack / hexi

Make games the fun way!
MIT License
555 stars 83 forks source link

Is there a full API documentation? #19

Closed xetra11 closed 7 years ago

xetra11 commented 7 years ago

I'm looking for a full API documentation. Only using the Tutorials isn't helpful when It try to look for a specific functionality

edmand46 commented 7 years ago

+1

icarito commented 7 years ago

@Edisoni @xetra11 I guess for the most part you are looking for this: http://pixijs.github.io/docs/PIXI.Sprite.html :-D

Let's add it to the README!

xetra11 commented 7 years ago

@icarito I was more talking about the higher level API of Hexi not PIXIs doc. Or did I misunderstand you?

icarito commented 7 years ago

Yes you are right, API docs for hexi itself would nice to have. There is some valuable info in the comments for https://github.com/kittykatattack/hexi/blob/master/src/core.js with pointers to each of the components where other examples are to be found.

kittykatattack commented 7 years ago

Hi Everyone,

No, there aren't any API docs, and won't ever be. 100% of Hexi features and functionality is covered in the examples and tutorials folder.