Modules provide a container for your app's source code, resource files, and app level settings, such as the module-level build file and Android manifest file. Each module can be independently built, tested, and debugged.
Android Studio uses modules to make it easy to add new devices to
your project. By following a few simple steps in Android Studio,
you can create a module to contain code that's specific to a device type,
such as Wear OS or Android TV. Android Studio automatically
creates module directories, such as source and resource directories, and
build.gradle file appropriate for the device type.
Also, Android Studio creates device modules with recommended build configurations,
such as using the Leanback library for Android TV modules.
This page describes how to add a new module for a specific device.
Android Studio also makes it easy to add a library or Google Cloud module to your project. For details on creating a library module, see Create a Library Module.
Create a New Module
To add a new module to your project for a new device, proceed as follows:
- Click File > New > New Module.
- In the Create New Module window that appears, Android Studio offers
the following device modules:
- Phone & Tablet Module
- Wear OS Module
- Android TV Module
- Glass Module
- In the Configure your new module form, enter the following details:
- Application Name: This name is used as the title of your app launcher icon for the new module.
- Module Name: This text is used as the name of the folder where your source code and resources files are visible.
- Package Name: This is the Java namespace for the code
in your module. It is added as the
packageattribute in the module's Android manifest file.
- Minimum SDK:
This setting indicates the lowest version of the Android platform that the app
module supports. This value sets the
minSdkVersionattribute in the
build.gradlefile, which you can edit later.
Then click Next.
- Depending on which device module you selected, the following page displays a selection of appropriate code templates you can select to use as your main activity. Click an activity template with which you want to start, and then click Next. If you don't need an activity, click Add No Activity, click Finish, and then you're done.
- If you chose an activity template, enter the settings for your activity on the Customize the Activity page. Most templates ask for an Activity Name, Layout Name, and Title, but each template has activity-specific settings. Click Finish. When you create an app module with an activity template, you can immediately run and test the module on your device.
Android Studio creates all the necessary files for the new module and syncs the project with the new module gradle files. Adding a module for a new device also adds any required dependencies for the target device to the module's build file.
Once the Gradle project sync completes, the new module appears in the Project window on the left. If you don't see the new module folder, make sure the window is displaying the Android view.
Import a Module
To import an existing module into your project, proceed as follows:
- Click File > New > Import Module.
- In the Source directory box, type or select the directory of the module(s)
that you want to import:
- If you are importing one module, indicate its root directory.
- If you are importing multiple modules from a project, indicate the project folder. For each module inside the folder, a box appears and indicates the Source location and Module name. Make sure the Import box is checked for each module that you want to import.
- Type your desired module name(s) in the Module name field(s).
- Click Finish.
Once the module is imported, it appears in the Project window on the left.
Once you've added a new module, you can modify the module code and resources, configure module build settings, and build the module. You can also run and debug the module like any other app.
- To learn about build settings for a module, see The Module-level Build File.
- To build and run a specific module, see Select and build a different module.
You'll also want to add code and resources to properly support the new device. For more information about how to develop app modules for different device types, see the corresponding documentation:
- For Wear OS modules: Creating and Running a Wearable App
- For Android TV modules: Get Started with TV Apps
- For Glass modules: GDK Quick Start
As you develop your new module, you might create device independent code that is already duplicated in a different app module. Instead of maintaining duplicate code, consider moving the shared code to a library module and adding the library as a dependency to your app modules. For more information on creating a library module and adding it as a dependency, see Create an Android Library.