Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 112 lines (85 sloc) 3.342 kb
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
1 cocos2d for iPhone
2 ==================
3
4 [cocos2d for iPhone][1] is a framework for building 2D games, demos, and other
32de24e @ricardoquesada MacPort: Ported ParallaxTest
ricardoquesada authored
5 graphical/interactive applications for iPod Touch, iPhone, iPad and Mac.
50394ca @ricardoquesada Updated Box2d to v2.1.2 (SVN r100)
ricardoquesada authored
6 It is based on the [cocos2d][2] design but instead of using python it, uses objective-c.
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
7
8
9 Main features
10 -------------
11 * Scene management (workflow)
12 * Transitions between scenes
13 * Sprites and Sprite Sheets
14 * Effects: Lens, Ripple, Waves, Liquid, etc.
15 * Actions (behaviours):
16 * Trasformation Actions: Move, Rotate, Scale, Fade, Tint, etc.
17 * Composable actions: Sequence, Spawn, Repeat, Reverse
18 * Ease Actions: Exp, Sin, Cubic, Elastic, etc.
fe96681 @ricardoquesada Updated README
ricardoquesada authored
19 * Misc actions: CallFunc, OrbitCamera, Follow, Tween
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
20 * Basic menus and buttons
21 * Integrated with physics engines: Box2d and Chipmunk
22 * Particle system
23 * Fonts:
24 * Fast font rendering using Fixed and Variable width fonts
25 * Support for .ttf fonts
26 * Texture Atlas support
27 * Tile Map support: Orthogonal, Isometric and Hexagonal
28 * Parallax scrolling
29 * Motion Streak
fe96681 @ricardoquesada Updated README
ricardoquesada authored
30 * Render To Texture
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
31 * High Score server (cocosLive library)
32f31a8 @ricardoquesada Updated README with Mac information
ricardoquesada authored
32 * Touch/Accelerometer on iOS
fe96681 @ricardoquesada Updated README
ricardoquesada authored
33 * Touch/Mouse/Keyboard on Mac
34 * Portrait and Landscape mode on iOS
35 * Sound Engine support (CocosDenshion library) based on OpenAL
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
36 * Integrated Pause/Resume
37 * Integrated Slow motion/Fast forward
6d43119 @ricardoquesada Fixed issue #793
ricardoquesada authored
38 * Fast textures: PVR compressed and uncompressed textures
1f3ad61 @ricardoquesada updated Reame with "Point" based
ricardoquesada authored
39 * Point based: iPhone4 + RetinaDisplay mode compatible
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
40 * Language: objective-c
41 * Open Source: Compatible with open and closed source projects
38da8d7 @ricardoquesada Updated README.md with improved installer instructions
ricardoquesada authored
42 * OpenGL ES 1.1 (iOS) / OpenGL 1.5 based (Mac)
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
43
44
1f3ad61 @ricardoquesada updated Reame with "Point" based
ricardoquesada authored
45 This library does not work with the toolchain, but it should be easy to port it to it.
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
46
47
48 Build Requirements
49 ------------------
50
b5f2dff @ricardoquesada Test bug-914: Improved internal documentation
ricardoquesada authored
51 Mac OS X 10.6, Xcode 3.2.3 (or newer)
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
52
53
32f31a8 @ricardoquesada Updated README with Mac information
ricardoquesada authored
54 Runtime Requirements
55 --------------------
56 * iOS 3.0 or newer for iOS games
1a5d5e1 @ricardoquesada Preparing v1.0.1
ricardoquesada authored
57 * Snow Leopard (v10.5) or newer for Mac games
32f31a8 @ricardoquesada Updated README with Mac information
ricardoquesada authored
58
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
59
60 Files and Folders
61 -----------------
62
63 * cocos2d/
64 core files and folders of cocos2d
65 * cocoslive/
66 high score client library
67 * CocosDenshion/
68 sound engine library
69 * tests/
b5f2dff @ricardoquesada Test bug-914: Improved internal documentation
ricardoquesada authored
70 tests, demo examples
71 * templates/
72 folder that contains the Xcode templates
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
73 * experimental/
74 experimental stuff
75 * external/
76 3rd party libraries used by cocos2d or any other project.
77 * Chipmunk/: physics library
78 * Box2d/: physics library
79 * TouchJSON/: JSON parser
80 * Tremor/: OGG audio decoder
81
82
83 How to run the tests
84 --------------------
85
86 Xcode -> View -> Customize toolbar
df2d697 @ricardoquesada Updated install instructions
ricardoquesada authored
87 Then, drag "Active Target" and "Active Executable" to your top project tool bar.
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
88 Select the test you want to view in both drop downs and hit Build and Go.
89
90 How to start a new game
91 -----------------------
92
d69fd70 @Kjuly Modify typesetting of README.md: How to start a new game
Kjuly authored
93 Run the `install-templates.sh` script:
94
fa36386 @ricardoquesada README.mdown fixed instructions to install template
ricardoquesada authored
95 $ cd cocos2d-iphone
38da8d7 @ricardoquesada Updated README.md with improved installer instructions
ricardoquesada authored
96 $ ./install-templates.sh -u -f
d69fd70 @Kjuly Modify typesetting of README.md: How to start a new game
Kjuly authored
97
dfc20bc @ricardoquesada tempalte name improved. README.mkdown instructions improved
ricardoquesada authored
98 And then open XCode -> New Project -> User Templates -> cocos2d
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
99
100
fe96681 @ricardoquesada Updated README
ricardoquesada authored
101 How to contribute to the project
102 --------------------------------
103
104 Did you find a bug ? Do you have feature request ? Do you want to merge a feature ?
82d9bf2 @ricardoquesada fixed MarkUp in README
ricardoquesada authored
105
106 * [contributing to cocos2d][3]
fe96681 @ricardoquesada Updated README
ricardoquesada authored
107
108
50394ca @ricardoquesada Updated Box2d to v2.1.2 (SVN r100)
ricardoquesada authored
109 [1]: http://www.cocos2d-iphone.org "cocos2d for iPhone"
28a2bd3 @stuartcarnie Update README to markdown format for better viewing on GitHub
stuartcarnie authored
110 [2]: http://www.cocos2d.org "cocos2d"
fe96681 @ricardoquesada Updated README
ricardoquesada authored
111 [3]: http://www.cocos2d-iphone.org/wiki/doku.php/faq#i_found_a_bug_i_have_an_enhancement_proposal_what_should_i_do "contributing to cocos2d"
Something went wrong with that request. Please try again.