Wax

Editor setup

The Wax for Icarus extension for VS Code, and what you can do without it.

A mod is made of plain text files, so any text editor works.

For Visual Studio Code there is an extension called Wax for Icarus.

What the extension gives you

PartWhat it does
New ModA command that makes the folder and the first files of a mod.
Completion and error checkingType ui. and pick from a list of everything ui offers. Each entry has a short description. Mistakes are marked as you type.
The game's classesType game.Character. and pick from what a player character has. game:Find("IcarusPlayerState") gives an object whose members the editor knows.
Run in gameSends the open file, or the lines you selected, to the running game.
The logShows the game's log in the Output panel.
ProblemsLists your mod's errors in the Problems panel, each with its file and line.
Mods viewLists every mod with its state. Its buttons reload a mod, switch it off or on, and open it.

Developer mode

Four of those parts talk to the running game: Run in game, the log, Problems and the Mods view. They work by sending Lua to the game, and the game only takes Lua from outside in developer mode. In a normal install they stay empty.

New Mod, completion, error checking and the game's classes need no developer mode. Neither does hot reload.

To switch developer mode on, make an empty text file named dev.txt in Wax's folder, beside Scripts:

...\steamapps\common\Icarus\Icarus\Binaries\Win64\ue4ss\Mods\Wax\dev.txt

Then start the game, or start it again if it was running. To switch it off, delete the file.

Read The bridge and developer mode first. With that file in place, any program that runs as you can run code inside the game, and Wax no longer updates itself in the game.

How to get it

Install Wax into the game first. See Installing.

The extension is a .vsix file on the same release page as Wax.

  1. Download the .vsix file.
  2. In VS Code, open the Extensions view and click the ... menu.
  3. Choose Install from VSIX... and pick the file.

The extension may not be on the VS Code Marketplace yet. To check, search the Extensions view for "Wax for Icarus". Its id is RobertCincotta.wax-icarus.

Without the extension

You don't need it to write mods.

  • Saving a file reloads your mod. That is hot reload, and it works with any editor.
  • The log is on the Log page of the Wax panel, inside the game.
  • The command bar on that page completes names when you press Tab.
  • Every function is described in the reference.

On this page