Codea Air Code

This extension can connect remotely to the Codea iOS application, allowing to modify, tweak and debug Codea projects directly from Visual Studio Code.

Table of Contents

• Features
  • Editor
  • Parameters
  • Debugger
• Installation
• Usage
  • Connection
  • Files and Dependencies
  • Commands
• Requirements
• License
• Change Log

Features

Editor

Once connected to Codea, Visual Studio Code will list the files for the currently opened project, allowing to modify them, even if the project is running.

Parameters

The Codea button on the Visual Studio Code Sidebar will show the current parameters for the running project in Codea, if any.

All parameters can be controlled directly from Visual Studio Code even if the parameters are hidden in Codea, making it easier to tweak the projects.

Debugger

With a project running, Visual Studio Code can be used to attach to the running project and then used for debugging.

Some features such as modifying variables are not available yet but will be added in future updates of Codea and the extension.

Conditional Breakpoints

To set a condition on a breakpoint, right click a breakpoint and select Edit Breakpoint...:

Enter a valid Lua expression which must be true for the breakpoint to hit.

Installation

Search for "Codea Air Code" in Visual Studio Code's Marketplace and install the extension.

Usage

Connection

After installing the extension, open the Command Palette (Ctrl+Shift+P on Windows, ⇧⌘P on Mac), and run the Codea: Connect to Host... command to connect to a running instance of Codea on an iOS device.

After typing Enter or clicking the command, Visual Studio Code will ask for Codea's IP:

To find the device's IP to connect to, use the Air Code icon on the project selection screen in Codea. The default port is 18513.

Fun Fact

The idea for this extension started as a proof-of-concept of a browser based "Remote Console". The idea was to see a Codea project's logs and execute commands directly from a web browser.

Air Code's default port 18513 is actually based on the letters R (18) E (5) M (13), for REMote console.

Files and Dependencies

Files can be added, removed or renamed in Codea using the corresponding operations in Visual Studio Code.

Dependencies can be added to the active project using the Add dependency... command.

To remove a dependency, simply delete its corresponding folder in the Explorer.

Commands

All commands included with this extension are prefixed with Codea:.

Requirements

Codea 3.8

License

MIT License

Change Log

See the change log here