Skip to Content
Introduction

MudForge Docs

Welcome to the official documentation for MudForge Web Client - a browser-based client for connecting to Multi-User Dungeon (MUD) text-based games.

What is MudForge?

MudForge is a modern, feature-rich MUD client that runs entirely in your web browser. It supports:

  • Multiple Connections - Connect to multiple MUD servers simultaneously
  • Plugin System - Extend functionality with Lua-based plugins
  • Custom Widgets - Create canvas, HTML, and text widgets for custom UI
  • Automation - Triggers, aliases, timers, and variables
  • Protocol Support - GMCP and MSDP protocol handling
  • Mobile Support - Responsive design for desktop and mobile

Documentation Sections

API Reference

Complete reference for all plugin API functions:

  • Drawing functions (shapes, text, images, gradients)
  • Widget management
  • MUD interaction (send, echo, triggers, aliases)
  • Protocol access (GMCP, MSDP)
  • Multi-session support

Plugin Development

Learn how to create plugins:

  • Plugin structure and lifecycle
  • Widget creation and management
  • Drawing and graphics
  • Working examples

Quick Start

-- Simple Canvas Plugin
print("Loading...")
 
local widget = createWidget({
  type = "canvas",
  title = "My Plugin",
  width = 200,
  height = 100
})
 
local function draw()
  clear("#1e1e2e")
  drawRect(10, 10, 180, 80, "#89b4fa")
  drawText("Hello MudForge!", 30, 55, "#cdd6f4")
end
 
registerWidgetEvent(widget, "resize", function() draw() end)
 
function init()
  draw()
end
 
print("Loaded!")
Last updated on
Overview