jerome Posted January 22, 2014 Share Posted January 22, 2014 Hello, Currently Phaser has four main sources of documentation :the getting started guides and tutorials which help to .. start using the framework and figure out what could be possible to do,examples which are useful use cases about very precise features,API doc which describes the behavior of each class/method/member,forum where everyone may expect to find solutions about everything else ...Same developer questions so often come back in the forum because people can't retrieve previous answers or hardly can express the same problem with same words. And many questions/answers concern more functioning or concepts (why tweens don't collide, do I use sprite or body coordinates, how do I organize my code, my states, why this with tilemaps, why that with atlases, cameras, etc ?) than syntax programing issues as the API is quite well documented. So I am wondering about opening some wiki for the community would help ?say, some topics would be listed (sprite, rendering, tilemaps, collisions, physics, etc) and benevolant contributors could write up their general knowledge, once for all, about concepts related to the questions.Like the way Wikipedia works.This may be a basis for a future complete documentation (or book for Rich). I can't see any embedded wiki in IP.Board . Too bad, we can't re-use forum accounts for authentication. If current forum contributors feel interested in this project, I could run an authenticated wiki (which one ?) on my local architecture.Please let me know. pato_reilly and Arlefreak 2 Link to comment Share on other sites More sharing options...
rich Posted January 22, 2014 Share Posted January 22, 2014 There is the Github wiki we could use? jerome 1 Link to comment Share on other sites More sharing options...
jerome Posted January 23, 2014 Author Share Posted January 23, 2014 Great idea !!!and it's a better place than an external wiki. I just didn't think about it. In order to encourage contributors to write up their knowledges or practices, I suggest not to impose a too rigid text organization for begining. Gathering content is the priority, then only we could arrange it in order.Maybe just start with a pool of topics like : game, states, preloader, sprites, physics, groups, tweens, tilemaps, world/camera, inputs, text (list to be extended) Let's start ? Link to comment Share on other sites More sharing options...
jerome Posted January 23, 2014 Author Share Posted January 23, 2014 I can see there are already some small docs here : https://github.com/photonstorm/phaser/wiki/_pages There is the Github wiki we could use? Link to comment Share on other sites More sharing options...
rich Posted January 23, 2014 Share Posted January 23, 2014 Yeah feel free to edit / add to the tiny bit of what is there. Link to comment Share on other sites More sharing options...
Pert Posted January 23, 2014 Share Posted January 23, 2014 Then there is this http://pages.github.com/ too. But good idea, good documentation makes good framework into exceptional framework. jerome 1 Link to comment Share on other sites More sharing options...
Tumetsu Posted January 23, 2014 Share Posted January 23, 2014 I'd suggest adding more visible links to few tutorials and wiki into phaser.io site. I found the first game tutorial by accident and I think that this kind of material should be easily accessible via main site. Link to comment Share on other sites More sharing options...
rich Posted January 23, 2014 Share Posted January 23, 2014 Don't worry as soon as I've got 1.1.4 out the door I can focus on getting the full site built (I'm not doing it, but still need to spend time handing it over). Here are a few sneak peaks at the design: jerome, Mike, tackle and 3 others 6 Link to comment Share on other sites More sharing options...
neon Posted January 23, 2014 Share Posted January 23, 2014 Yes links to documentation and examples on http://phaser.io/ would be nice. And phaser.io/examples are not working for me. I get errors like "Unable to load basics/01 - load an image.js". So I always look on http://gametest.mobi/phaser/examples. Link to comment Share on other sites More sharing options...
Zaidar Posted January 23, 2014 Share Posted January 23, 2014 There will be a shop section ? Link to comment Share on other sites More sharing options...
jerome Posted January 23, 2014 Author Share Posted January 23, 2014 @rich Very nice design !good work. Link to comment Share on other sites More sharing options...
rich Posted January 23, 2014 Share Posted January 23, 2014 Yeah I'll fix examples.phaser.io once I finally finish 1.1.4. And yes, there will be a shop section (eventually). Link to comment Share on other sites More sharing options...
Heppell08 Posted January 23, 2014 Share Posted January 23, 2014 This fills me with so much excitement! This is one of the best things I've read for phaser that is happening. Get the community in on showing how to do what etc! Yeah I'm backing this 110%! Also the website sneak peak looks awesome! Nice work there Rich and phaser team! Link to comment Share on other sites More sharing options...
jerome Posted January 23, 2014 Author Share Posted January 23, 2014 started here : https://github.com/photonstorm/phaser/wiki/Phaser-General-Documentation-:-Gamemenu : https://github.com/photonstorm/phaser/wiki/_pages all of you guys, feel free to re-organize and correct my poor english or my wrong assertionsfeel free to start/complete/add any of other items you want the goal is not to describe every class (API doc is good for this) but to introduce and explain concepts, and for some classes to detail how those concepts are managed thru methods or properties. That's why I talk a lot about the Game class here.the goal is to gather the maximum of information once for all too, even if organization or coherence is not that good at the beginningeverything will be cleared, reviewed, etc laterright stuff first. apart : here's my french general presentation for Phaser http://jerome.bousquie.fr/phaser/it could be translated into english (or your native language) easily with web translatorsplease, let me know if I wrote quite wrong things Pixelguy 1 Link to comment Share on other sites More sharing options...
jerome Posted January 25, 2014 Author Share Posted January 25, 2014 First part about what is a Phaser game (then a Game object), sequence of states, game loop, etcalmost complete, here : https://github.com/photonstorm/phaser/wiki/Phaser-General-Documentation-:-Game I hope I can present well the concepts (as well as I understand them so far) need to add many links to the example site, to pertinent forum answers alsoand other of your good ideas :-) Link to comment Share on other sites More sharing options...
tackle Posted January 25, 2014 Share Posted January 25, 2014 Yeah I'll fix examples.phaser.io once I finally finish 1.1.4. And yes, there will be a shop section (eventually). I'm curious - what would such a shop sell?Games? Phaser components? Link to comment Share on other sites More sharing options...
Heppell08 Posted January 25, 2014 Share Posted January 25, 2014 Yeah I'm pretty curious about that shop too lol Link to comment Share on other sites More sharing options...
jerome Posted January 26, 2014 Author Share Posted January 26, 2014 first part of general documentation about Game completed, as I don't know what to append morehttps://github.com/photonstorm/phaser/wiki/Phaser-General-Documentation-:-Game review needed pleasefeel free to add other considerations Link to comment Share on other sites More sharing options...
rich Posted January 26, 2014 Share Posted January 26, 2014 I'm curious - what would such a shop sell?Games? Phaser components? Books, support packages, advanced long-form tutorials, game templates, premium plugins. All kinds of thing really. Not that any of them exist yet mind you But got to think ahead. Link to comment Share on other sites More sharing options...
Heppell08 Posted January 26, 2014 Share Posted January 26, 2014 updated groups stuff. Needs more but put more than enough in for now! https://github.com/photonstorm/phaser/wiki/Phaser-General-Documentation-:-Groups jerome 1 Link to comment Share on other sites More sharing options...
Recommended Posts