This plugin assumes you have Xcode installed at its default location in the Applications folder.
It also assumes that Solar2D is in the Applications folder. You should rename the downloaded Corona-[xxxx] folder to Solar2D
After installing or updating Xcode you must open it atleast one time before installing the plugin.
Behavior Scripts
This plugin installs a bunch of behavior scripts. Behaviour scripts extends Xcodes functionality. You can run them by hitting the assigned keyboard shortcuts or pick them from the menu bar at Xcode > Behaviors. The first time you run a behavior script you will be prompted to turn on GUI scripting for Xcode. You have to do this for the scripts to work.
Here are the assigned shortcuts:
⌘⌥O Import Solar2D Project
⌘D Solar2D API lookup
⌘$ Show Project Files
⌘⌥$ Show Project Sandbox
The Import Solar2D Project behavior is used to import Solar2D projects that were not created in Xcode. You can use it to quickly open for example Solar2D sample code or your own projects. The script doesn’t mess with the files in the project, it just creates a xcodeproject file referencing the Solar2D project folder. You only import your project once after that you open it by clicking the generated xcodeproject file.
When using the Solar2D API lookup script you need to select a Solar2D library call in your code (you can do this by double clicking it) and hit ⌘D. The documentation will pop up in your default browser.
Xcode Key Bindings
This plugin installs a custom Solar2D keybinding set in Xcode. You can always change back to the default keybinding set by going to Xcode > Preferences > Key Bindings.
Miscellaneous
Here are some other relevant Xcode shortcuts:
⌘R Run (opens or relaunches Solar2D Simulator with current project)
⌘⇧N New project (Find Solar2D Templates under the label Cross-platform > Solar2D)
⌘N New file (Find Solar2D Templates under the label Solar2D)
Note: when relaunching your project with ⌘R you might see an alert saying something like "[YourApp] is already running. Click Stop to terminate and launch a new instance (...)". If you see this message just toggle on "Do not show this message again" and hit the Stop button. If you hit the Add button Xcode might fire up multiple instances of the simulator and things will get messy...
If you are new to Xcode the best way to get started is probably by following the steps in this video.
Troubleshooting
Q: When trying to run my project I get a message like this "Launch error. There is a problem launching posix_spawn"?
A: This message is thrown when Xcode is unable to find the Solar2D folder. Make sure you have a Solar2D folder (renamed from the Corona-[xxxx] download) in the Applications folder of the computer.
Q: Solar2D Syntax Highlighting doesn’t work after updating Xcode?
A: You always need to re-install the plugin after updating Xcode.
Q: How do I use this plugin with Xcode beta versions?
A: Xcode beta versions are usually named something like Xcode_beta.app. To install the plugin with beta versions you need to rename it to Xcode.app and run the plugin installer again. After that you can rename the beta version to whatever you like.