Skip to end of metadata
Go to start of metadata
Chapters

This guide details the module creation process inside Appcelerator Studio. For more information on what methods and properties are available as part of the module API and specific platform notes, see the Android Module Development Guide and iOS Module Development Guide.

Preparing Appcelerator Studio for Module Creation

If you are going to be creating Android modules, you will need to install Java support inside Appcelerator Studio. See Installing the Java Development Tools for the brief steps if you have not already done so.

For Android Module Development

You will need to install the Android NDK. Download the appropriate .zip file from http://developer.android.com/sdk/ndk/index.html and extract it to some location on disk. Remember this location.

Icon

As an additional note, you need to make sure the path to your Studio workspace does not contain spaces. See Switching your Workspace for how to switch your workspace location. You can then import your projects from the old to the new workspace. This is a limitation of the Android NDK

Creating a New Module

Creating a new module is accomplished by running through a wizard. Below summarizes the properties required, and a description of the values.

Property

Description/Purpose

moduleid

This is a read-only module id of your module that is generated when you created your project. You should not edit this value. NOTE: you must generate a unique id. We recommend using your reverse-DNS company name + module_name as a pattern to guarantee uniqueness. The Titanium Marketplace will only allow unique module ids when distributing modules. If you must edit this value, you must also edit the value in your module implementation file.

version

This is the version of your module. You should change this value each time you make major changes and distribute them. Version should be in the dotted notation (X.Y.Z) and must not con-tain any spaces or non-number characters.

description

This is a human-readable description of your module. It should be short and suitable for display next to your module name.

author

This is a human-readable author name you want to display next to your module. It can simply be your personal name or an organizational name such as "Appcelerator".

license

This is a human-readable name of your license. You should use a short description such as "Apache Public License" or "Commercial".

copyright

This is a human-readable copyright string for your module. For example, "Copyright (c) 2010 by Appcelerator, Inc."

Module Creation Steps

  1. Open File > New > Mobile Module Project.
  2. Choose a project name, a module ID, and a deployment target (native platform).
  3. Click Next.
  4. Fill out the remainder of the items on the next page.
  5. Click Finish.

Your module is created. Note the two different folder structures, depending on the platform.

Icon

You may need to refresh your project to show missing files. See related ticket http://jira.appcelerator.org/browse/TISTUD-948. For Android, you may also need to manually add JARs to your build path. See related ticket http://jira.appcelerator.org/browse/TIMOB-6839 for the workaround.

Building/Packaging a Module

Choose Deploy > Package - iOS Module or Package - Android Module.

You may then choose to deploy the module for all projects, or for a specific project. This follows the installation rules as noted in Using Titanium Modules, though to summarize:

  • For all projects: the module .zip file is dropped at the root of the the Titanium SDK installation location.
  • For a particular project: The module .zip file is dropped at the root of your project.

Troubleshooting Build Errors

Your Android application project path contains spaces

You need to change your Studio workspace to not have spaces in the path. See the top of the page for information on how to do that.

Android.ndk property is not set

If you see this, you need to add android.ndk to the build.properties file. Set it to the path where you installed the NDK to begin with.

Using Your Module

Follow the instructions in Using Titanium Modules for more information.

Uploading your Module to the Marketplace

To distribute your module through the Titanium+Plus Marketplace, you'll first need to package normally. Once you have tested your module locally and are ready to distribute it, you can then submit it to the marketplace for distribution. There are several prerequisites you'll need before you can distribute:

  • You must have a valid Appcelerator developer account.
  • You must have fully completed filling our your manifest values.
  • You must have a valid license text in the LICENSE file in your project.
  • You must have a valid documentation file in the index.md file in your documentation directory of your project.
  • You must specify some additional metadata upon upload such as the price (which can be free).
  • If you are charging for your module, you must establish a payment setup with Appcelerator so we can pay you.
  • You must accept the Titanium+Plus Marketplace terms of service agreement.
  • Once you have upload your module and completed the necessary submission steps, your module will be queued for submission and availability in the marketplace directory.

Start by visiting the Open Module Marketplace.