The Cocos2d-x Programmers Guide

cocos2d-x
#82

hey thanks, it’s good to know there’s an expert hangin around :smile: :smile:

#83

finally we have a website for that :smiley:

#84

Please note my comments in the thread below regarding additional information about Touch events that is not currently included in the Programmer’s Guide Ch. 8. [Resolved] Passing the touch & event to the underlying node

#85

Thanks. I replied and also created an issue in GitHub for this.

#86

Hello Everyone. I am considering changing the Programmers Guide to use MkDocs. It has a wealth of features that seem awesome, including a better table of contents and search capabilities (using haystack and solr). It is also easy to customize the theme.

Here are a few screenshots.

Here is the project: http://www.mkdocs.org

What does everyone think? Anyone good a CSS and want to help customize it?

c626fab161c4cc80.png1433×772
6116e48a65765a0a.png1163×773

2 Likes
#87

Hi Everyone.

I have temporarily replaced the Programmers Guide with a version created using mkdocs

Please take a look: slackmoehrle.github.io

What doesn’t work:

  • links to the pdf and pub (simply because they are not there yet)

What do I need to do:

  1. modify the CSS to better suite our UI. (I have already forked the theme to start with a base)
  2. get search working after building and copying to Amazon instance

I’d like to know what you all think and if you have ideas/feedback?

#88

I think it looks marvelous.

But pls don’t work that much on the layout. The content should be what is important (right now).
The css can be edited later.

#89

Agreed. We do need it to look a bit better though but nothing major. If anyone wants to do the CSS, let me know!

#90

Re: discoverability:
Any official doc representing Cocos2d-x should be updated to include a note redirecting users to the Programmers Guide for the most recent documentation. i.e., http://www.cocos2d-x.org/docs/catalog/en, http://www.cocos2d-x.org/reference/native-cpp/V3.2/index.html, etc.

One of the greatest frustrations when first learning was determining what docs to disregard and what docs were relevant.

And, the MKDocs version with the default theme looks great. You mentioned elsewhere the benefit of a user-commentary section on each page. That would be good.

#91

Yeah the new doc looks very good and well structured.

#92

Thanks. I got your PM. I’ll gather my thoughts and reply soon

#93

@EMebane The URL that you mention: http://www.cocos2d-x.org/docs/catalog/en
is going to go away, I think. It’s not very updated.

The docs will be re-organized to where the programmers guide and the api references are the main places to visit. This means we will be improving the API reference as well. If you find functions, etc that are not clear what they do, shoot me a message so I can add a more accurate description so it gets updated when the docs are generated.

#94

Alright everyone. The new Programmers Guide site is live: http://cocos2d-x.org/programmersguide

There are more chapters going up

Search is being finalized

@catch_up has volunteered to help with some CSS/UI tweaks.

#95

yeah… :smile:

#96

The latest version is an immense improvement over what was there in the past.

What I’d love to see is the ability to choose between c++ and lua code samples.

Keep up the great work guys!

#97

Nice docs! BTW, I like the first version style.

#98

We have talked about this and are coming up with ideas to make this seamless.

#99

I did refered to the programmer’s guide at times.
Recently, I was into multi player game programming with cocos2d-x.

The parts of the programmer’s guide seems to give beginner’s level knowledge at good level.
Yet I feel that it would have been good if we have some advanced topics in it.
If some basic example would have been there that shows multi player programming then it would have been good because I am not finding anywhere to implement it with cocos2d-x.

So, I wanted to ask the author which advanced topics will be covered in the guide,
and simultaneously I would like to request to cover advanced topics showing other APIs of cocos2d-x
once the basic things of the guide are completed.
By advanced things I meant like, I saw that API reference has more Actions then what are just mentioned like: cardinal, Progress to, Follow and many others. So, after what author is intended to finish, is there a possibility that you’ll cover these things also. I mean, if moveBy is covered then no need to cover JumpBy because they’re highly similar but please cover what are not similar.
Similarly, there are other APIs which are not covered.

Hope you’ve planned something for future enhancement to make it to advanced level.

Thank You.

#100

Still no word on my PR. This is regarding C++11 usage.

#101

We have, take a look here: https://github.com/chukong/programmers-guide/blob/master/outline.md

If you have ideas for topics, create a GitHub issue so I can have what you want in a central location.