axmol/tools/console

axmol-console

Vision of axmol-console

A command line tool that lets you create, run, publish, debug, etc… your game. It is the swiss-army knife for axmol.

This command line tool is in its early stages.

Examples:

# starts a new project called "My Game" for multi-platform

$ axmol new MyGame -l cpp -p org.axmol.mygame

$ cd MyGame

# Will deploy the project to device and run it
$ axmol run -p android

Devel Info

Internals

axmol.py is an script whose only responsability is to call its plugins. axmol.bat will invoke axmol.py on windows axmol will invoke axmol.py on Mac OS X and linux

To get a list of all the registered plugins:

$ axmol

To run the "new" plugin:

$ axmol new

Adding a new plugin to the console

You have to edit bin/axmol.ini, and add the class name of your new plugin there. Let's say that you want to add a plugin that deploys the project:

# should be a subclass of CCPlugin
project_deploy.CCPluginDeploy

And now you have to create a file called project_deploy.py in the plugins folder. A new, empty plugin, would look like the code shown below:

import cocos

# Plugins should be a sublass of CCPlugin
class CCPluginDeploy(cocos.CCPlugin):

		# in default category
        @staticmethod
        def plugin_category():
          return ""

        @staticmethod
        def plugin_name():
          return "deploy"

        @staticmethod
        def brief_description():
            return "Deploy the project to target."                

        def run(self, argv, dependencies):
            print "plugin called!"
            print argv

Plugins are divided by category, depending on it's function: project, engine, ...

The plugins of project is in default category, it's an empty stirng "".

Generate Executable

Now you can use the toexec/build_console.py for generating a executable file of cocos command.

Environment Requirement

• Python 2.7 (2.7.5 is well tested)
• PyInstaller (PyInstaller 2.1 is well tested)
• Necessary PATH environment for python & pyinstaller.

Attention:To keep compatible with both Windows-32bit & Windows-64bit, please install 32bit python on Windows.

Steps

Run python build_console.py in command line. Then the executable file & necessary files will be generated in toexec/output/PLATFORM.

The usage of build_console.py:

usage: build_console.py [-h] [-s SRC_PATH] [-d DST_PATH]

Generate executable file for axmol-console by PyInstaller.

optional arguments:
  -h, --help            show this help message and exit
  -s SRC_PATH, --src-path SRC_PATH
                        Specify the path of axmol-console.
  -d DST_PATH, --dst-path DST_PATH
                        Specify the path of output.

Using the Executable

The generated executable files can replace the source code of axmol-console.

To fit the limitation of the axmol-console implementation. The generated executable files should located at ENGINE_PATH/tools/console/bin.

Then you can use the executable file as same as the source code.

Commands Required

Please see this issue