Programmers-Guide

This is the Cocos2d-x programmers guide. It is licensed under the Creative Commons BY-SA license. You can find it here

Directory layout

• _layout.html5 - used for pandoc print page layout
• blank.md - a blank page that is used when building print versions
• build.sh - BASH script that build web and print versions, deploys to server
• chapters - markdown content and images
• main.css - CSS for print version
• mkdocs.yml - MKDocs configuration
• outline.md - outline of what this guide covers (may be out of date)
• README.md - this file :-)
• solarized-light.css - CSS for print version
• style.css - CSS for print version
• theme - custom theme for web version

What do you need to build for OS X?

• mkdocs: http://www.mkdocs.org/
• gpp: brew install gpp http://brew.sh/
• Bash 4.0: brew install bash
• Pandoc: http://johnmacfarlane.net/pandoc/getting-started.html
• A LaTex Distribution: http://www.tug.org/mactex/downloading.html
• run: sudo /usr/local/texlive/2014basic/bin/universal-darwin/tlmgr update --self
• run: sudo /usr/local/texlive/2014basic/bin/universal-darwin/tlmgr install collection-fontsrecommended
• run: sudo /usr/local/texlive/2014basic/bin/universal-darwin/tlmgr install ec ecc

How to run/test

• cd <where you cloned this repo>/programmers-guide
• run mkdocs serve

Any changes made while mkdocs serve is running are automatically rebuilt.

How to build for deployment

• cd <where you cloned this repo>/programmers-guide
• run build.sh

Content is build in docs and deployed to site. This script also builds the ePub and PDF versions as well as deploys out to staging (slackmoehrle.github.io) and http://cocos2d-x.org/programmersguide

How to add new content

• via a pull request. Please do not edit chapters directly.
• If you are creating a new chapter, please dont't make it feel and sound like an API Reference. This is a guide suited for new users (even though advanced users will benefit too). Please tell a story about your content. We want to make this engage the user. If in doubt. Read Chapter 2 and notice it feels like a chapter in a book.
• Contact me via e-mail or on the forums to discuss what you want to add, edit, etc.

I found an error

• report via GitHub issues: https://github.com/chukong/programmers-guide/issues
• or clone and submit a pull request to fix it: https://github.com/chukong/programmers-guide/pulls

Conventions used in this book

• auto is used for creating local variables.
• using namespace cocos2d; is used to shorten types.
• each chapter has a compilable source code sample to demonstrate concepts.

Outline.md - outline of what the guide will cover (may be out of date)

Appendices

• Appendix A - Prerequisites
• Appendix B - Android with Terminal Installation and Setup
• Appendix C - Android with Eclipse Installation and Setup
• Appendix D - iOS Installation and Setup
• Appendix E - Mac OSX Installation and Setup
• Appendix F - Linux Installation and Setup
• Appendix G - Win32 Installation and Setup
• Appendix H - WP8 Installation and Setup
• Appendix I - Creating A New Example Project

Chapters

• Chapter 01 - About
• Chapter 02 - Basic concepts and essentials
• Chapter 03 - Sprites
• Chapter 04 - Actions
• Chapter 05 - Building and Transitioning Scenes
• Chapter 06 - UI
• Chapter 07 - Other Node Types
• Chapter 08 - Event Dispatcher
• Chapter 09 - 3D
• Chapter 10 - Lua
• Chapter 11 - Services
• Chapter 12 - Physics
• Chapter 13 - Audio
• Chapter 14 - Advanced Topics