oiMUD

A mud web client that can connect to muds that expose a websocket port

Installation

• Copy all files from the dist folder to desired location
• Remove *.core. and *.interface. files if you plan to use full client and do not want to customize interface

Build

To build oiMUD you must have nodejs 20 LTS or >=22, npm, typescript 2.3+ Steps to build:

Prerequisites

Install or download Node: https://nodejs.org/en/download/

• Npm comes with most node installs, if not see: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm Install or download Typescript: https://www.typescriptlang.org/download/
• easiest to just use npm install typescript -g after node/npm installed

Steps

1. git clone https://github.com/icewolfz/oiMUD.git or git pull if already ready cloned, or you can download and unzip the source archive
2. npm install install all required modules, if already installed and do not need to update this skip can be skipped
3. nmp run build Builds bungled debug and release version for client

Advanced build options

For more advanced control you can run the build script directly using node build.js [arguments]

Build script arguments

1. -d,--debug,-debug Build just debug version, requires core, interface, or bungled
2. -r,--release,-release Build just release version, requires core, interface, or bungled
3. -a,--all,-all Build all scripts and css
4. -b,--bundled,-bundled Build just bundled interface and core
5. -core,--core Build just core version of scripts skipping any interface related code
6. -i,--interface,-interface Build just interface code and only adding minimum required core code
7. -te,--tinymce,-tinymce Build tinymce content css file
8. -p:[plugin],--plugin:[plugin],-plugin:[plugin] Build and add plugin, supply multiple times for multiple plugins, eg -p:test -p:shadowmud or as a comma delimited list: -p:test,shadowmud
   • test Add the test plugin
   • shadowmud Add the shadowmud plugin
   • mapper GMCP mapper plugin
   • chat ShadowMUD chat capture plugin, requires logger plugin to log chat
   • logger Text logger
   • msp Mud Sound Protocol and GMCP Client.media plugin
   • panelbar Panel bar with mini map and ShadowMUD chat capture panels, requires mapper and chat plugins
   • status Right status bar with limb, health and other options
   • core Add mapper, logger, and msp plugins
   • all Add all plugins

Note All arguments but all and tinymce need release or debug flag to build

The build script includes several advanced arguments to control what is built

Supported URL parameters

• host set a custom host to connect to, overrides set host
• port set a custom port to connect to, overrides set port

This will attempt to connect to example.com on port 23: http://URL/index.htm?host=www.example.com&port=23

FAQ

Basic questions answered about oiMUD

• oiMUD FAQ

References

• Interface
• Profiles
• Speedpaths
• Commands
• Functions
• Preferences
• Scripting
• Mapper

Known Issues

• Edge There are possible issues with websockets sending extra data causing data to buffer and corrupt sent commands, simply resend if it happens.
• IE 11 Not officially supported
• Chrome Screen readers may re-read the main display text from the beginning
• Mapper Due to browser storage limits mapping data may not correctly save.
  • Firefox you can increase your storage limits by changing the 'dom.storage.default_quota' setting open about:config, search for dom.storage.default_quota, and enter a larger #
• CClearer If installed or similar apps, it may monitor browsers and clear data on close or on a schedule, either turn off monitoring or check to ignore your browser
• All browsers ensure you do not have clear cookies or site data on close enabled or you will lose profiles and map data unless backed up to the mud or locally as text files
• Text selection
  • Firefox
  • Split scroll text selection hs some issues due to issues in firefox and mouse events
  • Custom selection highlight is not visible before version 135 due to not supporting the highlight api
  • All browsers, not matter custom or normal text selection may jump when mouse is moved outside of display control