Cocos2dx (Compilación)

Categoría: Cocos2dx

Nivel: Básico

En este artículo, voy a explicar cómo compilar los ejemplos que vienen en la librería Cocos2dx y como crear un proyecto multiplataforma para comenzar a desarrollar un juego. Aunque Cocos2dx permite hacer uso de lenguajes de script como lua y javascript para el desarrollo, yo solo me voy a centrar en c/c++ ya que es el lenguaje que más flexibilidad ofrece y el más compatible con todas las plataformas.

En la versión Cocos2dx 2.2.2 para compilar el código c/c++ sobre la plataforma Android se hace uso de un script bash de Linux que es necesario en versiones antiguas del NDK de Android, en la versión Cocos2dx 3.0 han eliminado estos scripts y hacen uso de scripts en Python que permiten compilar en Windows con las últimas versiones de NDK.

Debido a que la versión 3.0 acaba de salir y no tiene plantillas para todas las plataformas actualmente, iré actualizando el artículo según vayan añadiendo plantillas para las diferentes plataformas.

Creación de un proyecto multiplataforma:

(NOTA: a partir de ahora, la variable '%cocos2dx%' la usare como el directorio raíz de cocos2dx que contiene los directorios de la librería)

La creación de los proyectos para todas las plataformas se realiza mediante el script en Python que existe en la ruta '%cocos2dx%\tools\cocos2d-console\bin\cocos.py', si se han seguido los pasos del artículo dedicado a la instalación, se habrá creado una variable de entorno a la ruta, de modo que no es necesario entrar en ella para ejecutar el script.

Para crear el proyecto se abre una consola y se inserta el comando 'cocos', esto mostrara los comandos disponibles, la creación del proyecto se realiza con el comando 'new', de modo que insertamos 'cocos new --help' y se mostraran todas las opciones disponibles para la creación.

Básicamente este es el comando para crear un proyecto para todas las plataformas:

cocos new {Project Name} -p {Package Name} -l {Lenguaje} -d {Project Path}

Project Name: Nombre del proyecto que será creado
Package Name: Nombre del paquete en Java que será usado en el marco de aplicación de Android.
Lenguaje: Lenguaje usado para la creación del proyecto (Yo usare C++ = cpp).
Project Path: Ruta donde será creado el proyecto.

Como ejemplo crearé un proyecto para todas las plataformas disponibles usando c++:

cocos new MyGame -p com.dgzornoza.games -l cpp -d D:\dgonzalez\Projects\Games

El script creara una copia de las plantillas para todos los proyectos en la ruta que se haya indicado conteniendo una estructura como la siguiente:

Classes: Directorio con el código fuente común del juego, conteniendo una escena básica.
Cocos2d: Directorio raíz de la librería cocos2dx que es copiado para mantener las referencias al código fuente en todos los entornos.
proj.x: Directorios con los diferentes marcos de aplicación para cada plataforma específica.
Resources: Directorio con los recursos comunes del juego.

NOTA: Como se puede observar, se crea una copia de la librería completa en cada proyecto nuevo creado, esto tiene la ventaja de poder crear el proyecto en la ruta deseada, pero la desventaja de que cada proyecto ocupara unos 300MB, y una vez compilado será como mínimo 1GB.

Ahora solo queda compilar los diferentes marcos de aplicación para las plataformas, esto se puede realizar de dos formas diferentes:

1. Consola: Mediante el script 'cocos.py' se puede compilar sin necesidad de abrir y configurar un entorno específico, esta opción es muy útil para probar las diferentes plataformas de forma rápida.

2. IDE: Configurando el entorno correspondiente a la plataforma que se quiera compilar. Esta opción es útil en el entorno con el que se quiera desarrollar (en mi caso con Visual Studio y win32) y también si se quiere depurar en alguna plataforma especifica o para tener un mayor control sobre la compilación y resultado final.

Explicare ambas formas para todos los entornos para poder elegir la mejor al caso. Al ejecutarse el proyecto de prueba se podrá ver la pantalla del juego conteniendo la escena de ejemplo con el logo de cocos2dx:

Windows:

1. Consola: Dentro del directorio del proyecto creado, se ejecuta el siguiente comando:

   cocos run -p win32

2. IDE: Se entra en el directorio proj.win32, se abre la solución 'MyGame.sln' con Visual Studio (si el directorio donde reside no esta marcado como confiable es posible que se tengan que recargar los proyectos).
   Este es el proyecto con el que voy a trabajar para el desarrollo en Cocos2dx, ya que es el que más rápido va a compilar y el que menos requisitos necesita, una vez se tenga parte del código se puede compilar y probar en los diferentes dispositivos para verificar su correcto funcionamiento en todos ellos.

   La estructura de la solución contiene las librerías básicas:

   • libAudio: Librería con soporte para el audio.
   • libchipmunk: Librería con el motor de físicas chipmunk.
   • libcocos2d: Librería de cocos2dx.
   • MyGame: Proyecto principal creado para desarrollar el juego.

   Para compilar y ejecutar, se establece 'MyGame' como proyecto de inicio en el explorador de soluciones y se pulsa F5 para ejecutar.

WinRT:

Actualmente no está disponible, según los desarrolladores estará disponible en breve.

WP8:

1. Consola: Actualmente no está disponible la opción de compilación con la consola.

2. IDE:Se entra en el directorio 'proj.wp8-xaml' y se abre la solución, para compilar y ejecutar solo hace falta pulsar F5.

Android:

1. Consola: Antes de ejecutar el comando para compilar y ejecutar, se deberá iniciar el emulador o dispositivo físico deseado y desbloquearlo (en caso contrario puede dar algún error). Para iniciar el emulador lo más rápido sin abrir eclipse es ejecutar en una consola 'android avd' para abrir AVD Manager y gestionar los emuladores de forma visual. Otra forma es insertar el comando 'android list avd' para ver los emuladores configurados y ejecutar el deseado mediante 'emulator @nombre_emulador'

   Una vez iniciado y desbloqueado el dispositivo, dentro del directorio del proyecto creado, se ejecuta el siguiente comando:

   cocos run -p android -j 4

   (-j es un parámetro de la opción 'compile' que se puede usar en 'run' para acelerar el proceso de compilación con 4 o más jobs al mismo tiempo)

2. IDE: Para compilar sobre esta plataforma hay que seguir una serie de pasos ya que cocos2dx no tiene una plantilla específica para ningún IDE de desarrollo en Android. Las aplicaciones Android usan JAVA pero se permite interoperabilidad con c/c++ y ASM mediante el JNI (Java Native Interface), es posible configurar Eclipse para compilarlo todo, pero como yo voy a usar Visual Studio para el desarrollo de c/c++, solo usare Eclipse para compilar el marco de aplicación en JAVA.

   Como he comentado anteriormente, Cocos2dx 3.0 hace uso de un script en Python para compilar la librería estática c/c++ con el juego mediante el NDK de Android.

   1. Ejecutar el script 'build_native.py' en el directorio proj.android. Si se quiere compilar con las opciones por defecto se puede ejecutar directamente el script, en caso de querer modificar las opciones de compilación, se tiene que abrir una consola y navegar a la ruta del script tras lo cual se pueden ver las diferentes opciones del script ejecutando:

      build_native.py –help

      Por defecto será compilado en modo 'Debug' y para la API 10 (Android 2.3.3).

      Otra opción para compilar es usar el script cocos.py, si no se quiere ejecutar con ningún emulador, puede compilarse con el siguiente comando:

      cocos compile -p Android -j 4

   2. Abrir Eclipse y seleccionar menú File -> Import, se selecciona como fuente a importar código existente de Android y en la siguiente ventana como directorio raíz se selecciona la carpeta 'proj.android' del juego de prueba.

      
      
      
      

   3. Añadir la referencia a las clases JAVA de cocos2dx usadas por el marco de aplicación. Para ello se entra en las propiedades del proyecto (botón derecho -> propiedades), se selecciona 'Java Build Path' pestaña 'Source' botón 'link source':

      Y en la ventana que aparece, se establece la ruta a las clases base de cocos2dx para Android que están en la ruta: '%cocos2dx%/cocos/2d/platform/android/java/src'

      
      
      
      

      Ahora ya se puede ejecutar la aplicación desde el menú Run -> Run As -> Android Application y si todo ha ido bien, se iniciara el emulador con el juego.

      NOTA: es posible que al iniciar la aplicación de un error y el log indique algo así:

      Unable to execute dex: java.nio.BufferOverflowException. Check the Eclipse log for stack trace

      Esto se corrige instalando la librería de soporte de Android, Boton derecho en el proyecto -> Android Tools -> Add support library.

Iphone/Ipad, Mac OS X:

(Los siguientes pasos deben realizarse en un Mac OS X 10.7+)

1. Consola: Dentro del directorio del proyecto creado, se ejecuta uno de los siguientes comandos según se quiera ejecutar para IOS o Mac OS X:

   IOS: cocos run -p ios

   Mac OS X: cocos run -p mac

2. IDE: En la carpeta proj.ios está el archivo de proyecto xcode para estas plataformas, una vez abierto se selecciona el proyecto deseado y se ejecuta 'Cmd+R'

Compilando los ejemplos de Cocos2dx

La librería contiene algunos ejemplos para mostrar las características disponibles, existen ejemplos para lua, javascript y c++, pero no todos están disponibles para todas las plataformas.

De todos los ejemplos, 'TestCpp' que reside en la ruta '%cocos2dx%/samples/Cpp/TestCpp' contiene casi todas las características de la librería y es una buena referencia para aprender a usarla.

Para compilar los ejemplos lo ideal es usar el IDE correspondiente. A continuación indico como compilar los ejemplos en las diferentes plataformas:

Windows:

En la ruta principal '%cocos2dx%/build' reside la solución 'cocos2d-win32.vc2012.sln', una vez abierta con VS2012, se podrán ver todas las librerías de cocos2dx y todos los ejemplos disponibles de javascript, lua y c++, tan solo hay que establecer el ejemplo deseado como proyecto de inicio y ejecutarlo con F5.

WinRT:

Actualmente no está disponible, según los desarrolladores estará disponible en breve.

WP8:

Actualmente solo está disponible descargando la versión de desarrollo del repositorio en GitHub, en la siguiente reléase ya será incluida en el código fuente.

Android:

No existe plantilla para ningún IDE de desarrollo de Android, de modo que los pasos para compilar algún ejemplo son los mismos que he usado en la creación del proyecto multiplataforma mediante el IDE eclipse, pero esta vez debe compilarse el código c++ de los ejemplos usando el script en Python existente en la ruta '%cocos2dx%/build', una vez ejecutado serán compilados todos los ejemplos especificados en el script. Cuando termine de compilar, se deberá importar y configurar eclipse como he comentado anteriormente.

Iphone/Ipad, Mac OS X:

En la carpeta '%cocos2dx%/build' está la carpeta 'cocos2d_samples.xcodeproj' con el archivo de proyecto xcode para estas plataformas, una vez abierto se selecciona el proyecto deseado y se ejecuta 'Cmd+R'

Con los ejemplos compilados y conociendo como se puede crear un proyecto multiplataforma, ya se sabe lo básico para comenzar a probar la librería. En el siguiente artículo hablare sobre algunos conceptos básicos necesarios para comenzar a escribir código.

¿Has tenido algún problema en la compilación de los proyectos?

Saludos y… "a fluzear"