mirror of https://github.com/axmolengine/axmol.git
Merge pull request #3382 from ricardoquesada/improved_readme
Improved README.md
This commit is contained in:
minggo
commit
04ed8557d5
|
|
@ -0,0 +1,145 @@
|
||||||
|
<img src="http://www.cocos2d-x.org/attachments/801/cocos2dx_portrait.png" width=200>
|
||||||
|
|
||||||
|
|
||||||
|
cocos2d-x
|
||||||
|
=========
|
||||||
|
|
||||||
|
[](https://travis-ci.org/cocos2d/cocos2d-x)
|
||||||
|
|
||||||
|
[cocos2d-x][1] is a multi-platform framework for building 2d games, interactive books, demos and other graphical applications.
|
||||||
|
It is based on [cocos2d-iphone][2], but instead of using Objective-C, it uses C++.
|
||||||
|
It works on iOS, Android, OS X, Windows, Linux, Emscripten, Google Native Client, BlackBerry and Tizen.
|
||||||
|
|
||||||
|
cocos2d-x is:
|
||||||
|
|
||||||
|
* Fast
|
||||||
|
* Free
|
||||||
|
* Easy to use
|
||||||
|
* Community Supported
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
How to start a new game
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
1. Download the code from [Github][3] or from [cocos2d download site][4]
|
||||||
|
|
||||||
|
2. Run the `create-multi-platform-projects.py` script
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
$ cd cocos2d-x
|
||||||
|
$ ./create-multi-platform-projects.py -p mygame -k com.your_company.mygame -l cpp
|
||||||
|
$ cd projects/mygame
|
||||||
|
|
||||||
|
|
||||||
|
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][5] and [Chipmunk][6]
|
||||||
|
* Particle system
|
||||||
|
* Skeleton Animations: [Spine][7] 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 Independence
|
||||||
|
* Language: C++, with Lua and JavaScript bindings
|
||||||
|
* Open Source Commercial Friendly: 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 4.6+
|
||||||
|
* or Ubuntu 13.04+
|
||||||
|
* or Windows 7+, VS 2012+
|
||||||
|
|
||||||
|
|
||||||
|
Runtime Requirements
|
||||||
|
--------------------
|
||||||
|
* iOS 5.0+ for iPhone / iPad games
|
||||||
|
* Android 2.3+ for Android games
|
||||||
|
* OS X v10.6+ for Mac games
|
||||||
|
* Windows 7+ for Win games
|
||||||
|
* BlackBerry 10+
|
||||||
|
* Tizen 2.2+
|
||||||
|
* Emscripten
|
||||||
|
* Google Native Client
|
||||||
|
|
||||||
|
|
||||||
|
Running Tests
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Select the test you want from Xcode Scheme chooser.
|
||||||
|
|
||||||
|
* For OS X / iOS
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cd cocos2d-x/samples
|
||||||
|
$ open samples.xcodeproj
|
||||||
|
```
|
||||||
|
|
||||||
|
* For Linux
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cd cocos2d-x
|
||||||
|
$ ./make-all-linux-projects.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
or open the `cocos2d-x/cocos2dx-qt5.pro` file using QT Creator 5.
|
||||||
|
|
||||||
|
* For Windows
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
* For Android
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
|
||||||
|
Contributing to the Project
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
Did you find a bug? Do you have feature request? Do you want to merge a feature?
|
||||||
|
|
||||||
|
* [contributing to cocos2d-x][8]
|
||||||
|
|
||||||
|
|
||||||
|
Contact us
|
||||||
|
----------
|
||||||
|
|
||||||
|
* Forum: [http://forum.cocos2d-x.org][9]
|
||||||
|
* Twitter: [http://www.twitter.com/cocos2dx][10]
|
||||||
|
* Weibo: [http://t.sina.com.cn/cocos2dx][11]
|
||||||
|
* IRC: [https://webchat.freenode.net/][12] (#cocos2d and #cocos2d-x channels)
|
||||||
|
|
||||||
|
[1]: http://www.cocos2d-x.org "cocos2d-x"
|
||||||
|
[2]: http://www.cocos2d-iphone.org "cocos2d for iPhone"
|
||||||
|
[3]: http://www.cocos2d-x.org/projects/cocos2d-x/wiki/Download
|
||||||
|
[4]: https://github.com/cocos2d/cocos2d-x/tree/develop
|
||||||
|
[5]: http://www.box2d.org "Box2D"
|
||||||
|
[6]: http://www.chipmunk-physics.net "Chipmunk2D"
|
||||||
|
[7]: http://esotericsoftware.com/ "http://esotericsoftware.com/"
|
||||||
|
[8]: http://www.cocos2d-x.org/projects/cocos2d-x/wiki/Contribution
|
||||||
|
[9]: http://forum.cocos2d-x.org "http://forum.cocos2d-x.org"
|
||||||
|
[10]: http://www.twitter.com/cocos2dx "http://www.twitter.com/cocos2dx"
|
||||||
|
[11]: http://t.sina.com.cn/cocos2dx "http://t.sina.com.cn/cocos2dx"
|
||||||
|
[12]: https://webchat.freenode.net/ "https://webchat.freenode.net/"
|
||||||
64
README.mdown
64
README.mdown
|
|
@ -1,64 +0,0 @@
|
||||||
cocos2d-x
|
|
||||||
=========
|
|
||||||
|
|
||||||
[](https://travis-ci.org/cocos2d/cocos2d-x)
|
|
||||||
|
|
||||||
[cocos2d-x][1] is a multi-platform 2D game framework in C++, branched on
|
|
||||||
[cocos2d-iphone][2] and licensed under MIT. The master branch on github uses
|
|
||||||
OpenGL ES 2.0 rendering, while the old gles11 branch uses OpenGL ES 1.1
|
|
||||||
rendering. Currently we focus on gles20 developmenet.
|
|
||||||
|
|
||||||
Supported Platforms
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
* iOS: stable, well tested on iOS 5.x ~ 6.x SDK.
|
|
||||||
* Android: stable, well tested on 2.0~4.x, ndk r5 ~ r8. If you use gles20
|
|
||||||
branch or cocos2d-x v2.0 above, only android 2.3 and higher are supported
|
|
||||||
* Windows Phone 8 and Win8 Metro: stable, it's in another repo
|
|
||||||
http://github.com/cocos2d-x/cocos2dx-win8.
|
|
||||||
* Bada: cocos2d-x v1.x supports Bada SDK 1.0 & 2.0. Bada support was
|
|
||||||
deprecated since cocos2d-x v2.0.
|
|
||||||
* BlackBerry: stable, contributed by staffs in RIM, supports Playbook & BB10.
|
|
||||||
* Marmalade: stable since cocos2d-x v0.11.0, contributed by Marmalade's staff.
|
|
||||||
* Native Client (NaCl): contributed by the Native Client authors.
|
|
||||||
* Windows: stable, well tested on WinXP/Vista/Win7. Please upgrde the drive
|
|
||||||
of your video card if you meet problems on OpenGL functions
|
|
||||||
* Linux: support but not very stable.
|
|
||||||
* Emscripten: Alpha-level. Most features implemented. Needs testing.
|
|
||||||
Contributed by Zynga staff.
|
|
||||||
* Tizen: Experimental. Essential features implemented. Needs more implementing.
|
|
||||||
Contributed by Lee, Jae-Hong.
|
|
||||||
|
|
||||||
You can visit our continuous integration system http://ci.cocos2d-x.org to
|
|
||||||
check the stability on edge version.
|
|
||||||
|
|
||||||
Supported Programming Languages
|
|
||||||
-------------------------------
|
|
||||||
|
|
||||||
* C++ is the major programming language of cocos2d-x. Tons of top-chart
|
|
||||||
cocos2d-x games were written in C++.
|
|
||||||
* Lua binding is also widely used. Glu mobile, Zynga, UCWEB, 4399, Renren
|
|
||||||
Games are using lua on cocos2d-x.
|
|
||||||
* Javascript binding is our recommendation since 2012 H2. Cocos2d community
|
|
||||||
are cooperating on the same Javasciprt API on cocos2d-iphone/-x/-html5.
|
|
||||||
|
|
||||||
Documentations
|
|
||||||
--------------
|
|
||||||
|
|
||||||
* Wiki: [wiki.cocos2d-x.org][3]
|
|
||||||
* [Online API References][4]
|
|
||||||
|
|
||||||
Contact us
|
|
||||||
----------
|
|
||||||
|
|
||||||
* Forum: [http://forum.cocos2d-x.org][5]
|
|
||||||
* Twitter: [http://www.twitter.com/cocos2dx][6]
|
|
||||||
* Weibo: [http://t.sina.com.cn/cocos2dx][7]
|
|
||||||
|
|
||||||
[1]: http://www.cocos2d-x.org "cocos2d-x"
|
|
||||||
[2]: http://www.cocos2d-iphone.org "cocos2d for iPhone"
|
|
||||||
[3]: http://wiki.cocos2d-x.org "wiki.cocos2d-x.org"
|
|
||||||
[4]: http://www.cocos2d-x.org/projects/cocos2d-x/wiki/Reference "API References"
|
|
||||||
[5]: http://forum.cocos2d-x.org "http://forum.cocos2d-x.org"
|
|
||||||
[6]: http://www.twitter.com/cocos2dx "http://www.twitter.com/cocos2dx"
|
|
||||||
[7]: http://t.sina.com.cn/cocos2dx "http://t.sina.com.cn/cocos2dx"
|
|
||||||
Loading…
Reference in New Issue