搭建环境

This is the first part of the Getting started with Kotlin Multiplatform Mobile tutorial:

First step Set up an environment
Second step Create your first cross-platform app
Third step Add dependencies
Fourth step Upgrade your app
Fifth step Wrap up your project

Before you create your first application that works on both iOS and Android, you'll need to set up an environment for Kotlin Multiplatform Mobile development.

To write iOS-specific code and run an iOS application on a simulated or real device, you'll need a Mac with macOS. This cannot be performed on other operating systems, such as Microsoft Windows. This is an Apple requirement.

Install the necessary tools

We recommend that you install the latest stable versions for compatibility and better performance.

Tool Comments
Android Studio You will use Android Studio to create your multiplatform applications and run them on simulated or hardware devices.
Xcode

Most of the time, Xcode will work in the background. You will use it to add Swift or Objective-C code to your iOS application.

We generally recommend using the latest stable versions for all tools. However, Kotlin/Native sometimes doesn't support the newest Xcode right away. If that's your case, install an earlier version of Xcode.

JDK To check whether it's installed, run the following command in the Android Studio terminal or your command-line tool: java -version
Kotlin Multiplatform Mobile plugin In Android Studio, select Settings/Preferences | Plugins, search Marketplace for Kotlin Multiplatform Mobile, and then install it.
Kotlin plugin

The Kotlin plugin is bundled with each Android Studio release. However, it still needs to be updated to the latest version to avoid compatibility issues.

To update the plugin, on the Android Studio welcome screen, select Plugins | Installed. Click Update next to Kotlin. You can also check the Kotlin version in Tools | Kotlin | Configure Kotlin Plugin Updates.

The Kotlin plugin should be compatible with the Kotlin Multiplatform Mobile plugin. Refer to the compatibility table.

Check your environment

To make sure everything works as expected, install and run the KDoctor tool:

KDoctor works on macOS only.

  1. In the Android Studio terminal or your command-line tool, run the following command to install the tool using Homebrew:

     brew install kdoctor
    

    If you don't have Homebrew yet, install it or see the KDoctor README for other ways to install it.

  2. After the installation is completed, call KDoctor in the console:

     kdoctor
    
  3. If KDoctor diagnoses any problems while checking your environment, review the output for issues and possible solutions:

    • Fix any failed checks ([x]). You can find problem descriptions and potential solutions after the * symbol.
    • Check the warnings ([!]) and successful messages ([v]). They may contain useful notes and tips, as well.

    You may ignore KDoctor's warnings regarding the CocoaPods installation. In your first project, you will use a different iOS framework distribution option.

Possible issues and solutions

Make sure that you have Android Studio installed. You can get it from its official website.
  • Make sure that you have JDK installed. You can get it from its official website.
  • Android Studio uses a bundled JDK to execute Gradle tasks. To configure the Gradle JDK in Android Studio, select Settings/Preferences | Build, Execution, Deployment | Build Tools | Gradle.
  • You might encounter issues related to JAVA_HOME. This environment variable specifies the location of the Java binary required for Xcode and Gradle. If so, follow KDoctor's tips to fix the issues.
  • Make sure that you have Xcode installed. You can get it from its official website.
  • Launch Xcode in a separate window to accept its license terms and allow it to perform some necessary initial tasks.
  • Error: can't grab Xcode schemes. If you encounter an error like this, in Xcode, select Settings/Preferences | Locations. In the Command Line Tools field, select your Xcode.

    Xcode schemes

Kotlin Multiplatform Mobile plugin

  • Make sure that the Kotlin Mobile Multiplatform plugin is installed and enabled. On the Android Studio welcome screen, select Plugins | Installed. Verify that you have the plugin enabled. If it's not in the Installed list, search Marketplace for it and install the plugin.
  • If the plugin is outdated, click Update next to the plugin name. You can do the same in the Settings/Preferences | Tools | Plugins section.
  • Check the compatibility of the Kotlin Multiplatform Mobile plugin with your version of Kotlin in the Release details table.

Kotlin plugin

Make sure that the Kotlin plugin is updated to the latest version. To do that, on the Android Studio welcome screen, select Plugins | Installed. Click Update next to Kotlin.

You can also check the Kotlin version in Tools | Kotlin | Configure Kotlin Plugin Updates.

Make sure you have all the necessary tools installed:

Next step

In the next part of the tutorial, you'll create your first cross-platform mobile application.

Proceed to the next part

Get help