Installing Solar2D — macOS

This guide will help you get up and running with Solar2D for macOS.

Installing Solar2D

Before proceeding, ensure that your system meets the core requirements to install Solar2D.

We'll assume you've already downloaded Solar2D. If not, please do so before continuing.

Download Solar2D

  1. Locate the application disk image, for example Corona-2024.3703.dmg, and double click it. This should mount the disk image and, once you agree to the terms of service, present you with a disk image window:
  1. Drag the Corona folder into the Applications folder alias. This will copy the contents of the folder into /Applications.

You can use Solar2D without installing Apple's Developer Kit or the Android SDK. Later, if you want to build and test your code on a iOS device, you will need to sign up as an Apple Developer and create the necessary certificates and provisioning profiles (guide).

Java Development Kit

Installing JDK is no longer required for Solar2D 2020.3629 and later.

Installing Solar2D lets you create and test apps locally on your Mac. If you intend to build apps for testing on Android devices, you will need to install the Java Development Kit (JDK). If you try to build an Android app without the JDK installed, the Solar2D Simulator will help you install it. Alternatively, if you want to install it manually, you can follow these instructions:

  1. Go to JDK8 download page.
  2. Click the JDK download link to obtain the corresponding Java Platform (JDK).
  3. On the next page, read the license agreement and click the option to accept it if you agree.
  4. Locate the Mac OS X link and click it to download the file. This file will be named approximately jdk-8u261-macosx-x64.dmg.
  5. When the download is complete, open the .dmg and run the installer.

Text Editors

You'll need a text editor or IDE to write code for your Solar2D projects. If you don't already have a favorite text editor, the following options are recommended:

Development Environment

The Solar2D development environment consists of two aspects: the Solar2D Simulator and the Solar2D Simulator Console.

Simulator Options

The Solar2D Simulator for macOS features the following basic menu items:

Command Line Usage

To start a particular app in the Solar2D Simulator without double-clicking it, use a command like this:

"/Applications/Corona/Corona Simulator" ~/CoronaApps/MyApp

If the specified directory doesn't contain a main.lua file, an error is displayed. Optionally -project can be specified (note that this suppresses any error messages if the directory is invalid).

If you don't want the Simulator Console window to automatically appear use the -no-console option:

"/Applications/Corona/Corona Simulator" -no-console YES

Output from the Simulator will appear on standard output.

If you never want the Simulator to automatically start a console window, but for some reason cannot use the command line, you can run the following command in a Terminal window:

defaults write com.coronalabs.Corona_Simulator no-console -bool yes

Use this command to turn the Simulator Console back on again:

defaults delete com.coronalabs.Corona_Simulator no-console

One additional flag is allowed -debug YES which allows an IDE to connect a debugger to the Simulator session. Specify it before the directory/file argument.

Getting Started

If you're new to Solar2D, the most fun way to learn is to create a simple game. Don't worry if you've never created a mobile app or programmed before — the chapters in the guide will walk you through the entire process from start to finish!