API Reference

Adds a new alias.

Returns: boolean — True if added successfully.

gwc.alias.add({
  value: "gr",
  enabled: true,
  script: { language: "javascript", data: 'gwc.connection.send("smile warmly");' },
});

Removes an alias by its name/pattern value.

Returns: boolean — True if found and removed, false otherwise.

gwc.alias.deleteByName("gr");

Disables a named alias so it no longer fires on matching input.

Returns: boolean — True if the alias was found and disabled, false otherwise.

gwc.alias.disable("gr");

Updates an existing alias, matched by its value field.

Returns: boolean — True if the alias was found and updated, false otherwise.

const a = gwc.alias.find("gr");
a.script.data = 'gwc.connection.send("bow deeply to all");';
gwc.alias.edit(a);

Enables a named alias so it fires on matching input.

Returns: boolean — True if the alias was found and enabled, false otherwise.

gwc.alias.enable("gr");

Finds an alias by its name/pattern value.

Returns: Alias | null — The matching Alias, or null if not found.

const a = gwc.alias.find("gr");
if (a) gwc.output.append("Found: " + a.value, "script");

Sends a raw command string to the MUD server, as if typed in the command input.

gwc.connection.send("kill dragon");

Clears the foreground music queue.

gwc.music.clearQueue();

Adds the YouTube URL to the foreground music queue. If no foreground track is playing, interrupts the background music and plays it immediately.

gwc.music.queueUrl("https://www.youtube.com/watch?v=dQw4w9WgXcQ");

Restarts the current playing video to the beginning.

gwc.music.restart();

Skips the current foreground or background audio track and moves to the next.

gwc.music.skip();

Appends a new status line to the output window with optional color styling.

gwc.output.append("You have been hit!", "attack");
gwc.output.append("Treasure found!", "#ffd700");

Applies a foreground and background color to the most recently received output line.

gwc.output.color("script");
gwc.output.color("#ff4444");

Highlights all occurrences of a word in the most recently received output line.

gwc.output.colorword("dragon", "attack");
gwc.output.colorword("treasure", "#ff4444");

Returns the content of a stored output line by 1-based index.

Returns: string | null — The line content as a string, or null if the index is out of range.

const last = gwc.output.getLine(gwc.output.lineCount());
const lastHtml = gwc.output.getLine(gwc.output.lineCount(), true);

Returns the number of stored output lines.

Returns: number — The count of lines received and stored so far. Returns 0 before any output arrives.

const n = gwc.output.lineCount();
gwc.output.append("Lines so far: " + n, "script");

Replaces text in the most recently received output line.

gwc.output.replace("you", "YOU");
gwc.output.replace("you", '<span class="friends">YOU</span>', true);

Replaces the content of a stored output line by 1-based index. Prints a script error message if the index is out of range.

gwc.output.setLine(gwc.output.lineCount(), "-- replaced --");
gwc.output.setLine(1, '<span class="error">ERROR</span>', true);

Updates the browser tab title to draw attention to new activity.

gwc.tabs.notify("PROGRESS");

Adds a new trigger to the trigger list.

Returns: boolean — True if the trigger was added successfully.

gwc.trigger.add({
  name: "hp tracker",
  type: "regexp",
  value: "Your HP is (\\d+)",
  caseInsensitive: false,
  enabled: true,
  script: { language: "javascript", data: "gwc.localdata.hp = args[1];" },
});

Removes a trigger by name.

Returns: boolean — True if the trigger was found and removed, false otherwise.

gwc.trigger.deleteByName("combat tracker");

Disables a named trigger so it no longer fires on matching output.

Returns: boolean — True if the trigger was found and disabled, false if no trigger with that name exists.

gwc.trigger.disable("combat tracker");

Updates an existing trigger by name, replacing its properties with those of the provided object.

Returns: boolean — True if the trigger was found and updated, false otherwise.

const t = gwc.trigger.findByName("hp alert");
t.value = "Your HP is (\\d+)";
gwc.trigger.edit(t);

Enables a named trigger so it fires on matching output.

Returns: boolean — True if the trigger was found and enabled, false if no trigger with that name exists.

gwc.trigger.enable("combat tracker");

Finds a trigger by its name.

Returns: Trigger | null — The matching Trigger, or null if not found.

const t = gwc.trigger.findByName("hp alert");
if (t) gwc.output.append(t.value, "script");

Finds a trigger by its pattern value.

Returns: Trigger | null — The matching Trigger, or null if not found.

const t = gwc.trigger.findByPattern("^You are hungry");
if (t) gwc.trigger.enable(t.name);

Injects a line of text into the output window as if received from the server.

mud.Process.incoming("You have been killed by a dragon.\n");

Injects a raw GMCP data string as if received from the server.

mud.Process.incoming_gmcp('Char.Vitals {"hp":100,"mp":80}');

Sends a raw command string to the MUD server, bypassing alias processing.

mud.Process.outgoing("kill dragon");

Sends a GMCP message to the MUD server.

mud.Process.outgoing_gmcp("Core.Hello", { client: "MyClient", version: "1.0" });