Generating Live Builds
Live builds are a powerful and efficient way to see exactly how your
Build and deploy your app just once and then see code/assets update almost instantly on your devices.
Improve your workflow by testing on multiple devices and different platforms concurrently, all from a single code base.
Iterate on projects faster without rebuilding them to see the final result, even if they use native plugins like ad providers or game networking.
To use live builds on Windows, you must install iTunes.
Live Build Creation
To create a live build, simply follow these steps:
- In the Solar2D Simulator, open the Build dialog window
(File → Build) for either iOS, Android, or tvOS.
Confirm that the first several settings are correct in terms of how you typically build an app from the Solar2D Simulator. If you're not familiar with preparing/building apps for devices, please see the following guides:
Only Development provisioning profiles
- Check the Create Live Build option and, when you're ready, click the Build button.
| macOS | Windows |
|---|---|
 |
 |
After the build is successfully completed, a
.CoronaLiveBuildfile will be created in the project's root directory and the project will be added to Corona Live Server.Install the app on your desired device(s) as usual. If you're not familiar with this process, please see the documentation for iOS, Android, Kindle Fire, or tvOS.
You can install the same compiled/built app on multiple devices. For example, if you generate a standard .apk for Android, you can install it on multiple
- Run the app on the device as usual. Assuming everything is running as expected, code/asset changes that you make in your local project should be reflected almost instantly on the device.
When you run the app, make sure that the device(s) you're using are on the same local network as the computer where Corona Live Server is running.
Modifications to project configuration/setup files like
build.settingsandconfig.luawill not typically be reflected when the live build updates. Thus, you should generate a new live build andre-install it on the target device(s) after modifying these project files.If you experience any issues with project syncing, please consult the Troubleshooting section below.
Corona Live Server
Corona Live Server is an application which syncs project changes over your local network. Every time you create a live build, Simulator will initiate it and automatically add the built project to the Corona Live Server project list.
In order to sync a project, Corona Live Server must find a valid
.CoronaLiveBuildfile. As outlined above, this will be created when doing a live build for the project.To start Corona Live Server manually, select
Corona Simulator → Corona Live Server .You can add a project by pressing [+] and selecting the folder containing the project, or by simply dragging and dropping a folder onto the Corona Live Server dock icon (macOS) or shortcut (Windows).
Clicking the "close" button on the Corona Live Server window does not shut it down. To exit/quit entirely, do so from its main application menu or, alternatively, from the
right-click context menu of the dock icon (macOS) or system tray icon (Windows).Closing the project list window will not stop Corona Live Server. You can
re-open the window from the Window menu or by clicking on the Corona Live Server dock icon (macOS) or system tray icon (Windows).
Live Build File
Once a live build is successfully created, the source project will contain a hidden .CoronaLiveBuild file in its root directory. This file contains the information required to synchronize the project between the device and the development machine.
Typically, you will not need to edit the contents of this file. However, in very specific cases, it can be modified to customize the behavior of live builds and Corona Live Server:
key = XXXXXXXX-YYYY-ZZZZ-WWWW-AAA0987654321 #ip = #port =
key— Do not modify this property. Thisauto-generated key allows the live build and Corona Live Server to properly communicate.ip/port— Remove the#from each and specify these two values to use a static address and disable automatic discovery. This will enable live builds to work on older Android devices and, potentially, resolve some network issues. Theportvalue should be a number between1025and65534.
Troubleshooting
If the live build doesn't update/refresh, please proceed through the following instructions. If functionality returns to normal at any step along the way, do not proceed further.
- Ensure that both your computer and the device are connected to the same local network.
- Make sure your computer is running Corona Live Server with the same project you're running on the device.
- Turn off Wi-Fi on the device, wait several seconds, and turn it back on.
- Wait for "discoverability" to take effect. Depending on the network, this may take up to a minute.
- Quit Corona Live Server, then completely close/exit your app on the device. Note that merely closing the window does not quit Corona Live Server — you must explicitly exit/quit the application.
- Restart Corona Live Server and manually add your project to the list of synced projects as outlined in the Corona Live Server section above.
- Remove/uninstall the live build from the device.
- Rebuild the app and make sure that Create Live Build is selected from the build dialog window. Also, remember that only Development provisioning profiles
(iOS or tvOS) or Debug keystores(Android or Kindle Fire) can be used to produce live builds. - Start your app on the device and test for proper functionality. If the live build still doesn't update, experiment with modifying the
.CoronaLiveBuildfile as outlined in the Live Build File section above. - If you need further assistance beyond this, please consult the Solar2D Forums.