h1. Welcome to Cocos2d-X

Cocos2d-X is a game engine framework based on Cocos2d-iPhone, which consists of expanding supported platforms, with multiple choice of programming languages thats shares the same API structure. 

Programmers can choose to use their preferred language to achieve their targeted platform

* [[native|Native branch]] written in C++, with a little Java and Objective-C. Lua and javascript are binded as scripting language. 

* [[html5|HTML5 branch]], also known as cocos2d-html5, is written in Javascript, that focuses on desktop browsers

* XNA port, is written in C#, focus on Windows Phone 7 and XNA.

All the branches above are released under "MIT License":http://en.wikipedia.org/wiki/MIT_License. 

With cocos2d-x framework, developers can easily create or port their games onto iOS, Android, Bada, BlackBerry Qnx, Marmalade, WindowsXP/Windows7, Linux and Windows8 Metro.

We are aspired to create the world-class open source framework.

h1. Programming languages vs. Targeted platforms

"o" stands for: working

"i" stands for: supported but inactive/not merged/deprecated

"w" stands for: Work in Progress

|         |_. Platforms   |_. C++              |_. Lua    |_. Javascript |_. C#|                 

|_/7^. Mobile Platforms |=. iOS   |=. o |=. o      |=. w             |       |

|=. Android              |=. o                   |=. o       |=. w             |      |

|=. WindowsPhone7 |                          |            |                    |=. o |

|=. Bada                   |=. o                   |            |                    |        |

|=. BlackBerry QNX   |=. o                   |            |                    |        |

|=. MeeGo               |=. i | | | |

|=. Marmalade         |=. o                   |            |                    |        |

|_/4^. Desktop Platforms |=. win32 |=. o  |=. o |=. w  | |

|=. Linux |=. o | | | |

|=. Win8 Metro |=. o  | | | |

|=. Mac OS X |=. i | | | |

|_/4^. Web Browsers | HTML5 ready platforms | | |=. o | |

h1. Documentation

* [[native|C++ Programmers' Documentation Portal]]

* [[html5|Javascript Programmers' Documentation Portal]]

* [[Lua|Lua Programmers' Documentation Portal]]

h1. Download

* Stable Version (Recommend)

** http://download.cocos2d-x.org/

* Cocos2d-x github repo:

** http://github.com/cocos2d/cocos2d-x/

* Cocos2d-html5 github repo:

** http://github.com/cocos2d/cocos2d-html5/

h1. Contribution

Cocos2d-x, Cocos2d-html5 and Cocos2d-xna are provided to you free of charge. However, if you want to contribute to the project, here's a list of things you could do to help with the development

* If you find a bug!

** please kindly report the bug on our "forum":http://forum.cocos2d-x.org , post it on the correct subforum for your platform. Details on how to make the bug appear would be very helpful.

* If you fix a bug!

** please fork our repository on http://github.com/cocos2d/cocos2d-x/, and commit your fixed code

** or you can post your fix code on the forum, we will commit it to github

* I would like to add a port to another platform!

** please contact us via email/twitter/forum, etc. It would be our pleasure to add a subproject on this website for you!

** coding style: please reference the "Google CPP StyleGuide":http://code.google.com/p/google-styleguide/ Here's a zhCN version: "Google CPP StyleGuide in zhCN":http://code.google.com/p/zh-google-styleguide/

* Show cocos2d-x logo in your game

** We highly appreciated if you can show cocos2d-x logo in your splash screen or credit, get the logo image from [[Logo Resources of Cocos2d-x]]

h1. Support & Help

* Forum:  http://forum.cocos2d-x.org/

* Twitter: http://www.twitter.com/cocos2dx/

* Weibo: http://weibo.com/cocos2dx/

* mail: walzer (at) cocos2d-x.org