About¶

• Cocos2d-x is an open-source mobile 2D game framework, released under MIT License. It is a C++ version of cocos2d-iphone project. Our focus for cocos2d-x development is around making cocos2d cross platforms. On top of the framework provided by cocos2d-x, mobile games can be written in C++ or Lua, using API that is COMPLETELY COMPATIBLE with that of cocos2d-iphone. Cocos2d-x project can easily be built and run on iOS, Android, Samsung Bada, BlackBerry Table OS and more. Cocos2d-x also supports Windows and Linux, therefore we can debug source code easily and write editors on desktop operating systems.

• What the "x" in cocos2d-x means:
  • Sometimes, we write the .cpp file extension as .cxx. The "x" signifies that the project is written by C++, and offer C++ APIs.
  • The "x" also means CROSS. The goal of this open-source project is to allow its users to create cross-platform code. Currently supported platforms are the iPhone, Android, WoPhone, and win32 platforms, but more platforms can be made available upon request. Details on how to do this are at the bottom of this page.

Documentation¶

The following are a list of tutorials that discuss the basics of using cocos2d-x on your platform. They assume some prior knowledge about creating apps on your selected platform, and do not contain a lot of details unrelated to cocos2d-x. If you don't know anything about creating apps on your platform, you can still try reading through the tutorials, but it is highly encouraged that you learn about programming on your platform first. Finally, if you wish to see all the wikipages, simply click the tag cloud or "Index by title" in the sidebar.

• FAQ

• Installation & First Run
  • Platforms supported by cocos2d-x
  • iOS
    • How to run HelloWorld of cocos2d-x on iPhone Emulator
    • How to run tests of cocos2d-x on iPhone Emulator
  • Android
    • [deprecated] How to run HelloWorld on ndk r4 and r5
    • How to build and run HelloWorld
    • [deprecated] How to run test cases on android-ndk
    • How to create android project with script
    • Something about running on Android 3.0
    • Build HelloWorld for android x86 platform
    • Build project with ndk-r7
    • Some cautions of Android 4.0
    • How to use jni
    • Developing with cocos2d-x for android on linux by Marcio Andrey Oliveira
  • bada
    • (Updated--2012.1.12)How to run HelloWorld and tests of cocos2d-x on bada
    • How to create bada project with script
    • Some cautions of Bada Wave M
  • win32
    • Cocos2d-x Application Wizard for Visual Studio User Guide
    • How to remove cocos2d-x templates
  • linux
    • How to run HelloWorld and tests on linux
    • Create project for linux and android
  • BlackBerry Tablet OS
    • How to run HelloWorld and Tests on BlackBerry Tablet OS
    • How to create qnx project with script
  • Multi-platform
    • cocos2d-x (iphone-android)/IDE installation and setup under mac os (by Super SuRacccon)
    • How to create an iPhone and Android Cocos2d-x hybrid project (by clwoo)

• Features
  • Graphic
    • How does CCLabelTTF support line breaks and wrapping
    • How does cocos2d-x support multi-resolution
    • About the textures' maxsize in cocos2d-x
    • Editors for cocos2d-x Texture,Tilemap,Particle,Action,Level etc
    • Max size of textures in cocos2d-x depends on each platform
  • Audio
    • File formats supported by CocosDenshion on different platforms
  • Network
    • How to compile libcurl
  • File I/O
    • How to save/read file on different platforms
    • How does function fullPathFromRelativePath in class CCFileUtils work
  • Interaction
    • How to Enable Multi-Touch
    • Simulate android behaviors on win32
  • Thread
    • How to use pthread
  • Programming Language
    • Rules of translating objc to cpp
  • Lua
    • Some of my experiences for cocos2d-x + lua (by DragonCheng)
  • Tips and Attentions
    • About device orientation
    • Attentions on Android 4.0
    • Attentions on Bada Wave M
    • Build HelloWorld for android x86 platform
    • Build project with ndk-r7
    • Something about running on Android 3.0
    • The Opengl ES versions of different devices

• Tutorial: How to make a cocos2d-x simple game
  • Chapter 1 - How to Create a New cocos2d-x project on multi-platforms
  • Chapter 2 - How to Add a sprite
  • Chapter 3 - How to Move a sprite
  • Chapter 4 - How to Fire some Bullets
  • Chapter 5 - How to Detect the Collisions
  • Chapter 6 - How to Play Music and Sound Effect
  • Chapter 7 - Some Icing on the Cake

• Upgrade Guide
  • Methods deprecated in cocos2d-1.0.1-x-0.9.1
  • How to upgrade your game from 0.7.2 to 0.8.0
  • How to upgrade your game from 0.7.1 to 0.7.2

• Performance
  • 0.7.1
    • Performace Test of cocos2d-x 0.7.1 on iOS Devices
    • Performance Test of cocos2d-x 0.7.1 on Android Devices
    • Performance Test of cocos2d-x 0.7.1 on WoPhone Devices

DOWNLOAD¶

• Stable Version (Recommend)
  • http://download.cocos2d-x.org/

• Bleeding Edge Version from our github repository:
  • http://github.com/cocos2d/cocos2d-x/

• Open Source Games by the Community
  • Cocos2dxSimpleGame, it's translated from RayWenderlich's Cocos2dSimpleGame, a good tutorial for beginners.
  • share some source during my study in cocos2d-x, based on cocos2d-0.99.4-x-0.7.1, win32, by @chris
  • cocos2d-win32 installation & Essential source code translated from <Learn iPhone & iPad Cocos2d Game Development>, based on cocos2d-0.99.4-x-0.7.1, win32, by @supersu

CONTRIBUTION¶

cocos2D-x is 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 of

• If you find a bug!
  • please kindly report the bug on our forum , 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 Here's a zhCN version: Google CPP StyleGuide in zhCN

SUPPORT & HELP¶

• Forum: http://forum.cocos2d-x.org/
• Twitter: http://www.twitter.com/cocos2dx/
• Weibo: http://weibo/cocos2dx/
• Tencent QQ Group:
  • Group 1: 95115940 (full)
  • Group 2: 136017252 (full)
  • Group 3: 158628345
• mail: walzer (at) cocos2d-x.org