SmushClient

A cross-platform MUD game client fashioned after Nick Gammon's MUSHclient with MUSHclient API compatibility, built using Rust and the Qt framework.

Shown above: SmushClient running Quow's MUSHclient plugin pack, which was developed for the MUSHclient API.

Local Development

Prerequisites

• Rust
• Qt framework
• CMake

Building for Development

cd smushclient-qt
cmake -S . -B build/Debug
cmake --build build/Debug --config Debug

Building for Release

cd smushclient-qt
cmake -S . -B build/Release
cmake --build build/Relase --config Release

Running

SmushClient looks for resources according to the following directory structure:

Path	Description
<DIR>/lua/	Lua scripts
<DIR>/plugins/	Client plugins (.XML)
<DIR>/sounds/	Sound files (any format)
<DIR>/worlds/	World files

Related Links

• nickgammon/mushclient: Nick Gammon's legendary MUSHclient application, created in 1995.
• jnbooth/mxp: Rust libraries for parsing the MXP protocol. Comprises the majority of SmushClient's back end.
• jnbooth/lua-batteries-included: CMake config used by SmushClient for its Lua libraries.
• KDAB/cxx-qt: FFI system for using Rust libraries in C++ Qt.
• quow.co.uk: Home of Quow's MUSHclient plugin pack for Discworld MUD, which inspired this project.