Getting Started

DarkMistsCompanion (DMC) is a Mudlet Lua framework that enhances your Dark Mists experience with custom UI panels, real-time tracking, and gameplay utilities. DMC is mostly non-automating. Some optional modules (such as Enchanter Assist) can automate repetitive command sequences that you explicitly start and stop. It does not make autonomous gameplay decisions on your behalf. It organizes information, makes navigation easier, and provides tools to help you play more efficiently.

Interface Overview

DMC adds several persistent panels to your Mudlet layout. Each panel updates automatically in response to game events. Most panels live in a tabbed container — click the tab labels to switch between them.

Tabbed Windows

The main tabs — Chat, Affects, Who, Player and Destinations — share one tabbed container with a fixed header strip. Click a tab label to switch pages, or drag a label along the strip to reorder the tabs.

Pulling a tab out

Drag a tab label out of the strip to give it its own movable window; double-click a pulled-out tab to put it back in the strip.

• The window has a thin frame with a taller top band. Drag the top band to move it, drag a side or the bottom edge to resize it, and use the - / x buttons to minimise or close it.
• The tab's title is shown at the left of the top band.
• Pulled-out tabs are remembered: they come back undocked after a reload, with their frame and title restored.
• The container's right-click menu offers Save / Load for its geometry and lock styles, if you want to lock the frame in place.

Tab font

The tab label size is a setting: Appearance → Tab font size in the Settings Panel (dmc settings). It applies immediately, and the tab strip grows with the font so labels always fit.

Score Panel

The Player Status tab shows a live snapshot of your character's key statistics and refreshes mostly when you use the score command or when relevant events are received.

Sections

Status Bars

Horizontal gauges initially positioned at the bottom of your Mudlet window showing your vitals at a glance. An enemy health bar appears automatically when you enter combat.

Gauges

■ HP  ·  ■ Mana  ·  ■ Moves  ·  ■ Experience  ·  ■ Enemy HP (combat only)

Damage Messages

Appends an inline damage estimate to every combat hit line. The estimate is derived from the damage verb (e.g. wounds, mauls, PULVERIZES) and shows either the average, the full min–max range, or both depending on your mode.

Enabled by default. All options take effect immediately without reloading.

Settings Panel

The movable settings panel is available from the Button Bar > Settings menu or with dmc settings. It is organized into Appearance, Status Bars, Windows, Enchanter Assist, ShowDMG, ItemTracker, and Utilities pages. Valid changes are saved immediately.

Appearance includes pending Light/Dark theme mode, Full/Minimal UI mode, window font, font size, tab font size, and safe screen-border percentages. Status Bars includes enabled state, total height, and editable foreground/background RGBA colors. Status Bars are always movable. Windows includes Affects refresh and text lengths, original-line deletion, Who original-line deletion, Chat History message limit, and SkillUps history limit.

Enchanter Assist includes materials, recovery, enabled, and automatic-run controls, plus a session reset action that preserves configuration and attempted history. ShowDMG includes damage message mode and color. ItemTracker includes dark/light mode link colors. Utilities includes Spam Prevention, Stat Roller leniency and display settings, and MakeArmor sleeper, container, and default threshold. Settings marked with * require Reload UI before the change is applied.

Profile Info Box

The Mudlet profile info box is a small text area on the profile screen that you can use for custom notes. DMC exposes it through dmc infobox, so you can set or clear the text without leaving the game.

• dmc infobox <text> sets the profile info text
• dmc infobox clear clears the profile info box
• If you only run dmc infobox, DMC shows the usage summary

Chat History

The Chat tab keeps a scrollable log of all communication channels, color-coded by type. Up to 100 messages are retained per session. Both sent and received messages are captured, each with a timestamp.

Captured Channels

Filtering

The header above the log has single-letter toggle buttons to show or hide each channel. Click a letter to toggle that channel on or off — multiple channels can be combined. Hover any letter to see which channels it controls.

Who Window

The Who tab displays the online player list, captured automatically from the server's "who" output. Because the game does not push this data on its own, the window tracks when it was last updated so you always know how current it is.

• Player count and seconds since last refresh are shown in the header
• Click [Refresh] to issue a fresh who command immediately
• The age counter ticks up on every prompt — a quick glance tells you how stale the data is
• Player entries are displayed with the original server formatting and colors preserved

Affects Window

The Affects tab shows all currently active spells and status effects on your character. Like the Who Window, it captures a snapshot from the server and tracks how old it is.

• Click [Refresh] to re-issue the affects command and update the list
• Click [Clear Expired] to remove affects whose duration has elapsed
• The age counter updates every 2 seconds so you can see at a glance when the data was last fetched

Minimap

An interactive Geyser map widget showing your current position in the Dark Mists world. Displays room name, room ID, and area name alongside the graphical map.

• Updates automatically as you navigate between rooms
• Double-click a room on the map to walk there
• Map data is loaded from the bundled map.dat file (15,000+ rooms)

Button Bar

A docked menu bar at the top of your screen providing quick access to all DMC features via dropdown menus — no need to remember commands.

Menu Structure

Session Timer

A small ⏱ M:SS (or ⏱ H:MM:SS) display on the button bar that tracks how long you've been logged in to the current world session. Resets automatically on login or reconnect and stops on disconnect. Hover for a "Session timer" tooltip.

Navigation

The Map Destinations module lets you save named waypoints and speedwalk to them with a single command. Destinations are persisted to disk and survive restarts and reloads.

Utility Modules

Enchanter Assist

A formula discovery assistant for the alchemy skill. EnchanterAssist systematically tests combinations of material essences to help you discover new alchemy formulas. It tracks every combination already tried, manages resting automatically, and saves all progress to disk so sessions survive disconnects and reloads.

How It Works

1. Set the number of materials per attempt with es 1 through es 5 (default: 5).
2. Run es run for a single attempt, or es auto to run continuously.
3. When your mana or moves drop below 20 %, the module rests automatically (via bedroll sleep or mana potions) and resumes when you recover.
4. Every attempt — success or failure — is recorded and saved. Progress survives reconnects.
5. When a formula is discovered, an audio alert plays and the formula name becomes a clickable link to view its details with alc info <formula>.

Effect Colors

During a brew, enchantment result lines are color-coded to indicate what category of affect the material combination produces:

Commands

Make Armor

Automated make armor casting with quality checking. Casts make armor on an item, identifies the result, and fades if the total AC is below a configurable threshold. Manages resting automatically when mana is low.

Commands

Skill Ups

Tracks skill improvements as they happen and maintains a timestamped history of your recent gains. When a skill improves, a notification appears in your chat area. Skills improved this session are highlighted in a distinct color on the practice screen.

Clickables

Automatically enhances the output of practice, skills, and spells commands: skill names become clickable links and proficiency values are color-coded by percentage. No command is needed — this runs transparently whenever you use those commands.

Quest clickables

Clickable formatting applies to quest lines when your current quest list is shown.

Auction clickables

Clickable formatting also applies to auction list lines.

Vault clickables

Vault item numbers in === VAULT CONTENTS === listings are clickable.

Practice / Skills / Spells output

Essence display (alchemy)

When you view your stored essences, quantities are color-coded relative to the material cap:

Item Tracker

Look up items from the bundled database of 5,000+ Dark Mists items. Results appear as clickable links; hovering over a link shows a floating tooltip with the item's full stat block and details.

Spam Prevention

Spam prevention is configured through dmc spam. It tracks repeated commands and can deny them after a configurable threshold, optionally sending a fallback command when the limit is reached.

CMud Scripting Layer

CMudWrapper is a CMUD-compatible scripting layer built into DMC. It lets you define persistent aliases, triggers, variables, and classes using familiar CMUD syntax — all saved to disk and restored on each login. Every command is prefixed with #.

Aliases

Alias names may be multi-word — wrap them in braces: #alias {dr f} {drink flask}.

Inside an alias body:

• %1 %2 … — positional arguments from the alias invocation
• %-1 %-2 … — rest-of-args from position N onward (multi-word safe)
• %%1 %%2 … — delayed expansion (survive inner alias calls)
• @VarName — expands a stored variable
• | or ; — command separator (configurable with #sep)

Triggers

Wildcard Tokens (for #trigger)

Variables

Reference a variable with @VarName inside alias and trigger bodies. &VarName captures in trigger patterns auto-assign the variable.

Classes

Classes let you group aliases, triggers, and variables together so you can enable or disable them all at once. The current default class is applied to every new definition until you change or reset it. You can also assign a class inline as the last argument of #alias, #trigger, #rxtrigger, or #var — this overrides the default.

Enable / Disable

Individual aliases, triggers, and variables can be toggled on and off without removing them. Disabled items show in orange in listings; enabled items appear in green.

Async Delay — #WAIT

#WAIT pauses execution of remaining commands in an alias body and resumes them after a delay or after the next line arrives from the MUD. Shorthand prefixes like #WA are accepted.

Utility Commands

Coloring — #CW / #COLOR

#CW and #COLOR colorize output. Used with two arguments they create persistent triggers that fire on every matching line. Used with one argument inside a trigger body they colorize the current line.

The color argument is a single brace-wrapped token containing one or two space-separated Mudlet color names. A single name sets the foreground only (e.g. {red}); two names set foreground and background (e.g. {white black}). Both commands accept an optional third argument {class} to assign the auto-created trigger to a class. Run lua showColors() in the Mudlet script editor to list all available names.

Export

#export prints stored definitions back out as command lines you can copy or save. The output includes #class declarations first, followed by all aliases, triggers, and variables with their trailing class arguments — so the exported output can be re-imported exactly as-is.

Import — #IMPORT

#IMPORT loads a bundled preset: a text file of CMud command lines (the same format #export produces). Presets ship with the package and are read from <mudlet home>/DarkMistsCompanion/assets/cmud/{name}.txt.

• Preset files contain one #-command per line; blank lines and lines starting with ;; are ignored.
• A #class {name} {options} header also sets the current class for the lines that follow it (CMUD behavior).
• Import is idempotent — re-running it overwrites same-named definitions rather than duplicating them.
• To uninstall a preset, remove its class: #class {name} {remove} deletes the class and all member aliases/triggers.

Cross-Invocation

Alias bodies can call other aliases by name — just write the alias name as a command in the body. Trigger bodies can invoke aliases the same way. Self-recursion (an alias calling itself) is automatically blocked with a warning.

Examples

#alias z {zap %1}
#alias heal {cast heal %1|cast armor %1}

#var target skeleton
#alias kt {kill @target}

#trigger hitme {You are hit by * for %d damage.} {#show ouch!}
#trigger getitem {* drops &ItemName} {#show Dropped: @ItemName}
#rxtrigger hpline {^HP:\s*(\d+)/(\d+)} {#var hp %1|#var hpmax %2}

-- rest-of-args: "attack c blind" → attack1 = "c blind"
#alias attack {#var attack1 %-1}

-- delayed expansion: %%1 stays as %1 for the inner alias to receive
#alias outer {#alias inner {echo %%1}}

-- group combat aliases into a class, then toggle them together
#class combat
#alias atk {kill %1}
#alias fl {flee}
#class 0
#class combat 0     -- disables atk and fl
#class combat 1     -- re-enables both

-- hide internal helpers from listings (still active)
#class internal {hidden}
#alias _helper {some body} {internal}

-- multi-word alias names
#alias {dr f} {drink flask}

-- word and line coloring
#CW Abasdarhon blue              -- highlight the name in blue, permanently
#CW Abasdarhon {white black}     -- highlight white on black, permanently
#COLOR {You are hit} red         -- color the whole line red, permanently
#COLOR {You are hit} {yellow black} -- yellow text on black background, permanently

#sep ;
#alias combo {north;kill rat;get all}

-- wait 5 s then look
#alias j {#WA 5000|l}

-- loot, wait for next MUD line, then look
#alias loot {get all corpse|#WA|l}

-- disable a trigger without removing it, re-enable later
#T- hitme
#T+ hitme

Stat Roller

A character creation assistant that activates automatically during the stat-rolling phase of new character creation. It analyzes rolled stats in real time and helps you decide whether to keep or re-roll without needing to do mental arithmetic.

• HUD display: Shows your current stat block (STR / INT / WIS / DEX / CON), total, the best total seen this session, a trend sparkline, rolls per minute, and elapsed time.
• Leniency: Controls how strict the acceptance threshold is — 0 is most selective, 3 is most lenient. This is selected during character creation.
• Calibration rolls: Sets how many rolls are collected before the HUD switches from calibration to live status. This can be changed in the Settings Panel.
• Best roll memory: Tracks the highest total seen this session so you can compare new rolls against your best.
• Keepalive: Sends a blank input at regular intervals to prevent timeout during long rolling sessions.

Web Tools

DMC bundles several standalone HTML tools alongside the package. Open them in any browser — they are fully self-contained and require no internet connection.

Item Viewer — item-viewer.html

Search and filter the complete Dark Mists item database (5,000+ items). Filter by name, item type, stat ranges, and preset stat profiles (Melee, Tank, Caster, Healer). Results include a full stat breakdown for each item. Supports loading updated database files.

Alchemy Formula Parser — alchemy-formula-parser.html

Convert and analyze alchemy formula data. Useful for processing formula output dumps and visualizing material relationships discovered via Enchanter Assist.

Alchemy Material List — alchemy-mat-list.html

Searchable and sortable material source reference for alchemy. Includes material name, item examples, source locations, and notes so you can quickly find where to farm each material.

Line Formatter — line-formatter.html

Wraps lines of text to a set character length and optionally prepends a prefix (e.g. desc + ) to every line. Supports word-wrap with space-aware breaking and includes real-time line/character stats. Useful for formatting notes, descriptions, journals, etc.

EA Save Converter — ea-save-converter.html

Converts CMUD Enchanter Assist XML trial data (AttemptedSet) into a Mudlet-compatible ea_data.lua file for importing your previously attempted combinations.

Additional Resources for Mudlet

If you are new to Mudlet or migrating from another client, these official docs are a great place to start:

• Mudlet Manual: Introduction
• Mudlet Manual: Migrating
• Mudlet FAQ

Commands Quick Reference

Tips & Troubleshooting

Plugin update issues

• Spamming Enter while logging in can cancel an update download. Fix: quit the game and reconnect (disconnect/reconnect will not re-trigger GMCP). After reconnect, check that the load message appeared and the UI looks normal.

A panel is blank or not updating

• Confirm your UI mode is set to "full": type dmc ui on.
• Force an update by issuing the relevant command — for example, who to populate the Who Window, or any movement command to trigger a prompt refresh on the Score Panel.
• If status bars are missing, type sb recreate.

Enchanter Assist stops or won't start

• Hard stop completed: A previous es stop ran to completion. Type es auto to restart.
• Missing essence: You lack the essence for a material in the current combination. Check es missing — those materials are excluded from future trials automatically.
• All combinations exhausted: Every combination for the current part count has been tried. Increase the count with es 4 or es 5 and run again.
• Disconnected mid-attempt: A disconnect aborts the current attempt cleanly. Reconnect and run es auto to resume.

Walk can't find a path

• Confirm the map is loaded — the Minimap should be showing your current room.
• Some areas may have map gaps that break pathfinding. Try walk area <name> to navigate toward the general area first.
• Verify the destination name with walk list.

Clickable skills aren't appearing

• Clickable formatting only triggers when you send one of the relevant commands — type practice, skills, or spells to see the formatted, clickable output.

Chat History is empty

• The log is session-only and starts empty on each Mudlet launch. Messages are added as they arrive — no history is imported from before the session began.

Advanced Configuration

DMC stores its settings in darkmists_global_settings.lua inside your Mudlet profile directory. Most settings take effect on the next reload. You can also access common settings through the Button Bar → Settings menu or the dmc settings command.