Wax

The Wax panel

The window that comes with Wax: your mods, the log, a Lua command bar, performance, icons, an explorer of the running game and settings.

Wax comes with one window of its own, called Wax. Press F8 and it is there. It has six pages.

F8 shows and hides this panel and nothing else. A mod's windows have a key of their own, which you find on the mod's card of the Mods page. Escape hides everything that is up.

The line along the bottom is always visible. It says how many mods loaded and whether there are errors. On the right it shows the frame rate and the time Wax uses per frame.

Mods

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.

Every mod in the mods folder has a card here.

On the cardWhat it is
Statusloaded, switched off or failed. A failed mod shows its error in red underneath.
Load timeHow long the mod took to start.
EnabledSwitches the mod off and on. Wax remembers the choice.
Auto UpdateOnly on a mod that came from the catalogue. On, a newer version of that mod is put in by itself. Off, the card shows an Update to button when one is out.
Show / hideOnly on a mod that has a window. The key that shows and hides that mod's windows.
ReloadStarts the mod again from the top.
The six dotsAt the left of the card's name. Hold them and drag the card to another place in the list. Mods load in this order.
KindA card of an EXMOD table mod says so, and a line under it says how many values were applied and what was skipped.
BinRemoves the mod, after asking. Its folder is renamed, not erased, and a switch in the same line erases its saved settings with it. Get mods says how to bring it back.

In the picture the card of Entity ESP is open and the card under it is closed. That card is Prospector's Codex, under its earlier name, Recipe Browser. A card starts closed, unless its mod is new, has a problem or has an update to put in. Click its name to open or close it. A name too long for the card is cut short with three dots. Rest the mouse on it to read all of it.

Put the mods in another order

Hold the six dots of a card and move the mouse up or down. The card follows the mouse and the other cards make room. Let go and the card stays there, and Wax remembers the order.

  • The card stays inside the list while you hold it.
  • Held near the top or the bottom of a long list, the list scrolls.
  • An open card folds to its name while you hold it, and opens again where you put it down.
  • Escape puts the card back where it was. So does letting go outside the list.
  • A mod that needs another mod still loads after it. If you put it before that mod, the card goes back and a notification says why.
  • With a search typed, you move the cards that show.

The search box filters the list. Type part of a name, or one of these words: loaded, off, failed, new.

A mod Wax has not seen before is listed as new and switched off. Flip Enabled to load it. This is so whether the mod was added while the game ran or while it was closed.

Look for updates and Check now, above the cards, are for mods that came from the catalogue, and so is the Auto Update switch on such a mod's card. Get mods says what they do.

A key for each mod

Every mod that has a window has an Show / hide on its card. Press that key in the game to show the mod's windows, and press it again to hide them. The Wax panel and the windows of other mods stay as they are, so several can be up at once. The mouse is free while anything is up.

  • A mod can ask for a key. For a mod that asks for none, Wax picks the first of F6, F9, F10, F11, F5, F4, F3 and F2 that no window and no hotkey uses, and a notification tells you once which it is.
  • If a mod later makes a hotkey on a key that Wax picked, Wax picks another one and tells you.
  • To change it, click the key on the card and press the new one. A key can be held with Ctrl, Shift or Alt. Wax remembers your choice.
  • A key that the Wax panel, another mod's windows or another mod's hotkey already uses is given all the same. A notification says who else has it, and the card shows the clash until one of the two is changed.

Log

The Log page. Three switches for Errors, Warnings and Prints, then a search box, a Follow switch, a copy button and a clear button. Below them the log shows lines such as wax.gui theme Midnight. At the bottom is the command bar with a history button and a run button.

The log shows what Wax and your mods printed. The newest line is at the bottom.

  • The Errors, Warnings and Prints switches choose which lines show.
  • The search box keeps only lines that contain your text.
  • Follow keeps the newest line in view. Switch it off to read older lines.
  • Drag across lines to select them. Ctrl+C copies. Ctrl+A selects everything.
  • The copy button copies every line that is showing.
  • The clear button empties the view. The lines are hidden, not deleted.

Each line starts with who wrote it, in square brackets. Lines from your mod start with your mod's id.

The command bar

The box at the bottom of the Log page runs Lua in the game. Type a line and press Enter.

print("Hello World")

If you type something that has a value, the log shows the value after an = sign.

game.MapName
1 + 1

More to try:

ui.Notify("Hi from the command bar")

This one needs a character, so run it in a prospect. It lists the parts your character is made of.

for i, child in ipairs(game.Character:GetChildren()) do print(i, child) end

What else the command bar does:

  • Tab completes a name. Type game.Ch and a grey aracter appears. Press Tab to take it. Press Tab again for the next name that fits.
  • After a dot, Tab lists what is there. Type game. and press Tab. The log lists the names you can use.
  • The history button brings back the last command. Click again for the one before.
  • The run button does the same as Enter.
  • A command can wait. task.wait(2) print("later") works.

The command bar has every name a mod has (game, ui, task and so on), plus three extras:

NameWhat it is
mods.HelloThe globals of the mod with the id Hello.
exports.HelloWhat that mod's init.lua returned.
clear()Removes everything your commands made, such as windows and signal connections.

require does not work in the command bar. Reach a loaded mod through mods or exports instead.

Running Lua from outside the game

The command bar is inside the game, so it always works. A line you type there runs with the same rights as a mod.

A tool outside the game, such as the play button of the VS Code extension, can only run Lua in the game in developer mode. A normal install does not take Lua from outside. The bridge and developer mode says how to switch it on and what that allows.

Performance

The Performance page. It shows 181 frames per second, a frame time of 5.54 ms and Wax per frame 0.205 ms, a bar for the share of the frame used by Wax at 4 percent, and a section called Where it goes with a time for each part of Wax.

This page shows how much of each frame Wax uses.

On the pageWhat it is
Frames per second, Frame timeThe game's own numbers.
Wax per frameThe time Wax and all mods use in each frame.
Where it goesThat time, split between the parts of Wax. The waiting and repeating code of your mods is counted under Tasks.

The numbers are measured again every half second.

Icons

The Icons page. A search box sits above a grid of small buttons, each showing one icon. A line above the box says how many icons there are and that clicking one shows its name.

This page shows every icon you can use. Type in the box to search. Click an icon and a notification shows its name. Use that name anywhere an icon is accepted. See Icons.

Explorer

This page shows what is in the game while it runs, and lets you change it.

It has two sides. The left side lists what is in the game, and the right side shows what you picked. Both are laid out alike, from the top down: a heading with its buttons, one small line, a search box, two dropdowns side by side, one more row, and then the list.

The left side

From the topWhat it does
Explorer and its buttonThe button closes every row that is open.
The small lineSays how much is listed.
The search boxFinds something by its name or its class. With several words, all of them must match. The cross in the box empties it.
The first dropdownPicks what is listed: actors, creatures, players, items, buildings, components or everything.
The second dropdownSorts the list: by name, by class, nearest first or newest first.
The wide dropdownKeeps only what is within a distance of you, from 25 to 500 metres. Any distance from you shows everything.
The listThe first rows are the parts of game: Character, LocalPlayer, GameState, GameMode, GameInstance, Viewport and Engine. Under World are the actors of the current world.

A row with a small arrow has things inside it. Click the arrow to open the row. Click the row itself to pick it.

The right side

Until you pick something, the right side explains the page in four short lines.

From the topWhat it does
The name of what you pickedThe button with the curved arrow goes back to what you had picked before. The copy button copies the Lua that reaches the object.
The small lineShows that Lua.
The search boxFinds a member by its name or its type.
The first dropdownPicks what is listed: Properties, Functions, All or Changed.
The second dropdownSorts the list: By name or Changed first.
The value rowBelongs to the member you pick in the table. It is described below.
The tableOne row for each member: its name, its value and its type. The first row is the object's class, and its arrow shows what the class inherits from.

The values are read again while you look, and a value that changed is marked for a moment. That is how you find the property that goes with something you do in the game. Choose Changed to see only those, or Changed first to put them at the top.

In the table:

  • A value in colour is another object. Click it to go to that object.
  • A true-or-false member has a switch at the end of its row.
  • A vector, a rotator or a colour opens when you click it, and each part is a row of its own that you change like a number. Its arrow closes it again.
  • A list opens with its arrow and shows what is in it. The places of a list are shown, not changed.
  • A value that could not be read says so, and Wax leaves it alone.

Change a value

Click a member in the table. The value row, above the table, now shows its name.

  • For a value you can type, such as a number or a text, the row has a box. Type the new value and press Enter, or press the button with the tick.
  • For anything else the row says in a few words why there is no box.
  • The <> button copies the Lua that reads the member and the Lua that sets it.

Choose Functions to see the object's functions with their parameters. They are not called from this page. The <> button copies the call.

Changes as Lua appears under both sides after your first change. It lists everything you changed here as lines of Lua that do the same. Copy takes them for a mod, and Clear empties the list.

In a narrow window one side shows at a time, and a List button at the top of the right side takes you back.

A change here is a change in your game

Not every value is meant to be changed. Try things on a character you can afford to lose.

Settings

The Settings page with five rows: Wax panel key F8, Theme Midnight, Accent colour From the theme, an Animations switch that is on, and Interface size 100%.
SettingWhat it does
Wax panel keyThe key that shows and hides the Wax panel. Click it, then press a new key. It is F8 until you change it. A mod's windows have their own key, on the mod's card of the Mods page.
ThemeThe colours of every window. See Themes.
Accent colourThe highlight colour. From the theme uses the theme's own.
AnimationsSwitches the small movements on and off.
Interface sizeMakes everything larger or smaller. The list holds the sizes that text can still be read at on your screen, so a small game window offers fewer of them.

These settings are remembered the next time you play.

Add your own page

A mod can add a page to the Wax panel. Use it for tools you need while testing.

init.lua
local page = ui.Debug.Page("My mod", { icon = "wrench" })

page:Title("My mod", "Tools for testing.")

page:Button("Say hi", function()
    ui.Notify("Hi from my page.")
end)

page:Button("Print the map", function()
    print(game.MapName)
end)

The page goes away when your mod reloads, and comes back when init.lua runs again.

Write ui.Debug.Page with a dot, not a colon.

FunctionWhat it does
ui.Debug.Page(name, options)Adds a page and returns it. Add controls to it as you would to a window.
ui.Debug.Show()Shows the Wax panel and frees the mouse. Your own windows stay as they are.
ui.Debug.Window()The panel's window, or nil while the panel is not running.

On this page