Wax

Installing

Download Wax, put it in the game folder and check that it works.

What you need

ICARUS on Steam, on Windows. You install nothing else. UE4SS, the script loader Wax runs on, is in the download.

Download

The latest release has three zips. Extract the whole zip before you run anything in it.

ZipWhat it is
Wax-<version>.zipThe full download. It has the installer. This is the file the updater checks.
Wax-<version>-manual.zipThe same game files, with no installer. Copy the game folder by hand. This is the file on Nexus Mods.
Wax-Setup-<version>.zipWax Setup.exe. It finds the game and copies the files. It does not run a script.

The same page has the VS Code extension as a .vsix file. The editor page says what it is for.

It also has a .manifest file and a .manifest.sig file, with the same version in the name as the zip. They are the signed list of the release's files. You don't need them to install. Check a download by hand says how to use them.

In the full zipWhat it is
Install Wax.cmdCopies Wax into your game.
Update Wax.cmdLooks for a newer Wax and installs it.
Uninstall Wax.cmdRemoves Wax from your game.
Wax-Setup.ps1The script those three files run. It is plain text, so you can read what it does.
README.txtThe steps on this page, as a text file.
licensesThe licences of UE4SS and of the Lucide icons.
gameThe files that go into the game folder.

Inside game:

In gameWhat it is
dwmapi.dll and the ue4ss folderUE4SS.
ue4ss\Mods\WaxWax.
ue4ss\Mods\Wax\modsYour mods. It is empty after a new install.

Security says what each part does on your PC and how to remove it.

Install

Close ICARUS first. Then install in one of three ways.

Install with the installer

Double-click Install Wax.cmd. It finds the game through Steam and copies the files. If it can't find the game, it asks you for the folder.

Windows may ask you to confirm first, because the file came from the internet.

The installer asks one question: whether the Add to game button of the Mods page may open Wax on this PC.

  • Type y and press Enter for yes. Windows then hands links that start with wax:// to Wax. That takes one entry in your own part of the registry.
  • Press Enter alone for no. Everything else works without it. You download a mod as a zip.

Such a link can be on any web page, not only on the Wax site. So Wax shows you the mod and asks before it downloads anything, and a mod it adds stays switched off until you switch it on. The registry key says what the entry holds, how to remove it and how to make it later.

The installer also closes Wax's folder to the other Windows accounts on the PC. Your account and administrators can change it, and other accounts can only read it. Who can change Wax's folder has the reason.

Run the installer from the Windows account you play on. Under another account Wax could not save its settings.

Install with Wax Setup

Wax-Setup-<version>.zip holds one program, Wax Setup.exe. Close ICARUS, extract the zip, and run that program. It finds the game through Steam and copies the files. It does not run a script, and it does not change who can change Wax's folder.

It also sets up the Add to game button. That is one entry in your own part of the registry, the same kind the installer asks about. To leave that entry as it is, run Wax Setup.exe --install --no-links.

Windows may ask you to confirm first, because the program is not signed by Windows.

Install by hand

Use this for Wax-<version>-manual.zip, and for the game folder inside the full zip.

Copy everything inside the game folder into this folder of the game:

...\steamapps\common\Icarus\Icarus\Binaries\Win64\

To find it, right-click ICARUS in Steam and choose Manage, then Browse local files. Open Icarus, then Binaries, then Win64.

When you are done, dwmapi.dll and the ue4ss folder sit next to Icarus-Win64-Shipping.exe.

Copying by hand sets up no button and changes no permissions.

If you already use UE4SS

Wax is tested on the UE4SS build in the zip, so the installer puts that build in. If it finds a different one, it first copies the old files to a folder inside Win64. The folder's name is ue4ss-backup- followed by the date and time. Your other UE4SS mods in ue4ss\Mods are left alone.

UE4SS comes with a few small mods of its own. Three of them open the game's developer console and its cheat commands (CheatManagerEnablerMod, ConsoleCommandsMod, ConsoleEnablerMod), and the others load blueprint mods, add keys for UE4SS's own tools, or are examples. Wax needs none of them, so none of them is in the download: the only thing in ue4ss\Mods is Wax.

  • Earlier versions of Wax installed them. If you install over one of those and never changed ue4ss\Mods\mods.txt, the installer removes them and says so.
  • If you changed that file, the installer keeps it and the mods, and tells you which of the three above are switched on in it.

If you want one of them, get it from UE4SS's own release and list it in mods.txt as that release does.

Check that it works

Start the game

Start ICARUS the way you always do. Nothing else has to run next to it.

Press F8

The menu opens and you see the Wax panel. Its Mods page lists every mod Wax found. After a new install it is empty: the Browse page beside it has mods to add.

Look at the status line

The bottom of the panel says how many mods loaded, and whether there were errors.

The Mods page of the Wax panel. Under a search box are a Look for updates switch, a Check now button and two cards. The card of Entity ESP 1.0.0 is open: Status loaded, Load time 4.2 ms, an Enabled switch and an Auto Update switch that are on, Show / hide F6, a Reload button and a bin. The card of Recipe Browser 0.9.2 is closed. Each card has six dots at its left. The line along the bottom reads 2 of 2 mods loaded, no errors.
Here with two mods. A new install lists none. The picture shows Prospector's Codex under its earlier name, Recipe Browser.

Where Wax is

Wax sits in the UE4SS mods folder inside the game:

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

Two folders in there matter to you:

FolderWhat is in it
Wax\mods\Your mods. One folder for each mod.
Wax\saved\Settings that Wax and your mods save. You never need to edit these by hand.

Where your mods go

Each mod is a folder inside Wax\mods\. The folder holds a file called init.lua.

...\ue4ss\Mods\Wax\mods\
    MyFirstMod\
        init.lua

The folder name is the mod's id. Use only letters, digits, _ and - in it. A folder with another kind of name is skipped, and the log says so.

A mod that Wax has not seen before is listed switched off. Open the Mods page of the Wax menu and flip its Enabled switch. This is so whether the folder was put there while the game ran or while it was closed.

Updating

Close ICARUS first.

Update with the installer

Double-click Update Wax.cmd. It asks GitHub for the newest release of Wax. If that is newer than yours:

  1. It downloads the release's list of files and checks that the list carries the signature of Wax's author.
  2. It downloads the zip and compares it with the list.
  3. Only then does it install.

If any of that fails it changes nothing, and tells you to get Wax from the site instead. What is signed has the key and its fingerprint.

Use the Update Wax.cmd of version 0.2.1 or newer. The one that came with Wax 0.2.0 and older installs what it downloads without that check, so delete the folders of those older downloads.

You can also download the newest zip and run its Install Wax.cmd. Installing over an old copy updates Wax.

Both ways keep your mods (Wax\mods), your settings (Wax\saved) and your UE4SS settings. They also leave the Add to game button the way you set it.

Update with Wax Setup

Run Wax Setup.exe again. It puts the copy it carries over the one in the game, and keeps your mods and your settings.

Update by hand

Download the newest Wax-<version>.zip or Wax-<version>-manual.zip and copy the contents of game into Win64 again. Say yes when Windows asks to replace files.

Your own mods and your settings are not in the zip, so they stay. The UE4SS settings files UE4SS-settings.ini and mods.txt are replaced by the copies from the zip.

Updates in the game

While the game runs, Wax asks the catalogue whether a newer Wax is out. When one is, Wax downloads it, checks it against the same signature and puts it in the next time the game starts. If the new version does not start, the version before is put back.

Some versions need the installer. Wax then shows a notification that asks you to run Update Wax.cmd.

What Wax asks the network for says what is sent and how to switch this off.

Removing Wax

Close ICARUS first.

Remove with the installer

Double-click Uninstall Wax.cmd. It removes Wax and the registry entry of the Add to game button. It asks before it removes your mods and settings, and before it removes UE4SS. Press Enter at a question to keep them.

Remove with Wax Setup

Run Wax Setup.exe and choose remove, or run Wax Setup.exe --uninstall. It removes Wax and the registry entry of the Add to game button. Your mods and UE4SS stay unless you also pass --remove-mine or --remove-ue4ss.

Remove by hand

Delete this folder:

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

Your mods and settings are in it. Copy mods and saved somewhere else first if you want to keep them.

To remove UE4SS too, delete dwmapi.dll and the ue4ss folder from Win64.

If the Add to game button was set up, remove its registry entry as well. Open a Command Prompt and type:

reg delete HKCU\Software\Classes\wax /f

Switching a mod off, or removing it

  • To switch a mod off, use its Enabled switch on the Mods page. It stays off the next time you play.
  • To remove a mod, delete its folder from Wax\mods\.

Next: write your first mod.

On this page