Axmol Engine – A Multi-platform Engine for Desktop, XBOX (UWP) and Mobile games. (A radical fork of Cocos2d-x-4.0)
Go to file
Justin Hawkwood 852639cfe7 Added empty string check 2015-06-09 09:19:04 -07:00
build added Windows 10 UWP project files 2015-05-28 13:51:25 -07:00
cmake remove zlib in linux, because linux use system png and zlib 2015-04-07 23:20:03 +08:00
cocos Added empty string check 2015-06-09 09:19:04 -07:00
docs Remove vs2012 support in v3 2015-05-05 16:11:26 +08:00
extensions Add CURLOPT_NOSIGNAL to avoid multithread issue on timeout 2015-06-04 17:59:56 +08:00
external upgrade external version to 61 2015-06-04 19:57:01 +08:00
licenses Add the PolySprite support and adjust the project setting on the different platform 2015-04-23 00:51:47 +08:00
plugin@fbd9d50b94 Update pluginx 2015-04-23 19:08:03 +08:00
templates Merge pull request #12201 from samuele3hu/v3_bug_fix 2015-06-05 10:47:08 +08:00
tests samplers are treated as uniforms 2015-06-05 14:55:33 -07:00
tools Skip C++ invocation functions of Component 2015-06-04 20:05:30 +08:00
web@9e68d34194 Reverse change in submodules 2015-06-02 10:42:50 +08:00
.gitattributes fix line end in windows 2013-09-20 22:23:13 +08:00
.gitignore add framework build scripts to gitignore 2015-05-29 13:34:59 +08:00
.gitmodules Update js bindings & js tests. 2015-05-05 10:50:19 +08:00
.travis.yml change to use v3 branch 2015-04-30 13:50:43 +08:00
AUTHORS update changelog and authors 2015-06-08 17:30:59 +08:00
CHANGELOG update changelog and authors 2015-06-08 17:30:59 +08:00
CMakeLists.txt add JSB to jenkins 2015-05-25 16:37:08 +08:00
README.cmake fixes types in readme 2014-11-05 10:26:46 -08:00
README.md Fix clone URL in README.md 2015-06-07 13:29:32 +02:00
download-deps.py fixed download-reps.py: not to download lua runtime binaries 2015-03-11 14:50:39 +08:00
setup.py Solve the environment conflict with Cocos. 2014-12-11 11:14:30 +08:00

README.md

cocos2d-x

iOS Mac Linux Win32 Android Win8.1-Universal
v3 Build Status Build Status Build Status Build Status Build Status Build Status
v4 Build Status Build Status Build Status Build Status Build Status Build Status

cocos2d-x is a multi-platform framework for building 2d games, interactive books, demos and other graphical applications. It is based on cocos2d-iphone, but instead of using Objective-C, it uses C++. It works on iOS, Android, Windows Phone, OS X, Windows and Linux.

cocos2d-x is:

  • Fast
  • Free
  • Easy to use
  • Community Supported

Git user attention

  1. Clone the repo from GitHub.

      $ git clone https://github.com/cocos2d/cocos2d-x.git
    
  2. After cloning the repo, please execute download-deps.py to download and install dependencies.

      $ cd cocos2d-x
      $ python download-deps.py
    
  3. After running download-deps.py.

      $ cd cocos2d-x
      $ git submodule update --init
    

How to start a new game

  1. Download the code from cocos2d download site
  2. Run setup.py
  3. Run the cocos script

Example:

$ cd cocos2d-x
$ ./setup.py
$ source FILE_TO_SAVE_SYSTEM_VARIABLE
$ cocos new MyGame -p com.your_company.mygame -l cpp -d NEW_PROJECTS_DIR
$ cd NEW_PROJECTS_DIR/MyGame

Build and run a new project for Android

$ cocos run -p android -j 4

Build and run a new project for iOS

$ cocos run -p ios

Build and run a new project for OSX

$ cocos run -p mac

Build and run a new project for Linux

if you never run cocos2d-x on Linux, you need to install all dependencies by the script in cocos2d/build/install-deps-linux.sh

$ cd cocos2d-x/build
$ ./install-deps-linux.sh

Then

$ cd NEW_PROJECTS_DIR/MyGame
$ cocos run -p linux

Run

$ bin/MyGame

Build and run new project for win32

$ cocos run -p win32

Build and run new project for Windows 8.1 and Windows Phone 8.1

$ cocos new MyGame -p com.your_company.mygame -l cpp -d projects

Visual Studio 2013 Update 4 or later is required.

Starting with Cocos2d-x v3.3, you can create Windows 8.1 Universal Apps (Windows Store and Windows Phone 8.1) See more info on How to install and Create games on Windows RT (Windows and Windows Phone 8.1) at http://msopentech.github.io/cocos2d-x/

Starting with Cocos2d-x v3.6 there will no longer be support for Windows Phone 8.0

Main features

  • Scene management (workflow)
  • Transitions between scenes
  • Sprites and Sprite Sheets
  • Effects: Lens, Ripple, Waves, Liquid, etc.
  • Actions (behaviours):
    • Trasformation Actions: Move, Rotate, Scale, Fade, Tint, etc.
    • Composable actions: Sequence, Spawn, Repeat, Reverse
    • Ease Actions: Exp, Sin, Cubic, Elastic, etc.
    • Misc actions: CallFunc, OrbitCamera, Follow, Tween
  • Basic menus and buttons
  • Integrated with physics engines: Box2d and Chipmunk
  • Particle system
  • Skeleton Animations: Spine and Armature support
  • Fonts:
    • Fast font rendering using Fixed and Variable width fonts
    • Support for .ttf fonts
  • Tile Map support: Orthogonal, Isometric and Hexagonal
  • Parallax scrolling
  • Motion Streak
  • Render To Texture
  • Touch/Accelerometer on mobile devices
  • Touch/Mouse/Keyboard on desktop
  • Sound Engine support (CocosDenshion library) based on OpenAL
  • Integrated Slow motion/Fast forward
  • Fast and compressed textures: PVR compressed and uncompressed textures, ETC1 compressed textures, and more
  • Resolution Independent
  • Language: C++, with Lua and JavaScript bindings
  • Open Source Commercial Friendly(MIT): Compatible with open and closed source projects
  • OpenGL ES 2.0 (mobile) / OpenGL 2.1 (desktop) based

Build Requirements

  • Mac OS X 10.7+, Xcode 5.1+
  • or Ubuntu 12.10+, CMake 2.6+
  • or Windows 7+, VS 2013+
  • Python 2.7.5
  • NDK r10c+ is required to build Android games
  • Windows Phone/Store 8.0 VS 2013+
  • Windows Phone/Store 8.1 VS 2013 Update 3+

Runtime Requirements

  • iOS 5.0+ for iPhone / iPad games
  • Android 2.3+ for Android games
  • Windows Phone 8 and 8.1 for Windows Phone games
  • OS X v10.6+ for Mac games
  • Windows 7+ for Win games
  • Windows 8+ for WinRT games (Modern Apps)

Running Tests

Select the test you want from Xcode Scheme chooser.

  • For OS X / iOS
$ cd cocos2d-x/build
$ open cocos2d_tests.xcodeproj
  • For Linux
$ cd cocos2d-x/build
$ ./install-deps-linux.sh
$ cmake ..
$ make

Run Samples

$ bin/cpp-empty-test/cpp-empty-test
or
$ bin/lua-empty-test/lua-empty-test
  You may meet building errors when building libGLFW.so. It is because libGL.so directs to an error target,
  you should make it to direct to a correct one. `install-deps-linux.sh` only has to be run once.
  • For Windows

Open the cocos2d-x/build/cocos2d-win32.sln

  • For Windows 8.1 Universal Apps (Phone and Store)

Open the cocos2d-x/build/cocos2d-win8.1-universal.sln

  • For Android
$ cd cocos2d-x/build
$ python ./android-build.py cpp-empty-test -p 10
$ adb install ../tests/cpp-empty-test/proj.android/bin/CppEmptyTest-debug.apk

Then click item on Android device to run tests. Available value of -p is the API level, cocos2d-x supports from level 10.

Contributing to the Project

Did you find a bug? Do you have feature request? Do you want to merge a feature?

Contact us