Skip to content
/ Blightmud Public
forked from Blightmud/Blightmud

A terminal mud client written in Rust

License

Notifications You must be signed in to change notification settings

xvxx/Blightmud

 
 

Repository files navigation

Rust Clippy check Security audit Coverage Status

Blightmud : A mud client for the terminal

Blightmud has been a passion project of mine for some time. A big user of the old but great tinyfugue I always wanted to create my own similar mud client. Even though I don't play much muds these days.

screenshot

The name?

The client is written in rust. Some navigating throught the thesaurus brought me to the word 'blight' and here we are.

Features

  • Completely terminal based (mac and linux)
  • Telnet:
    • TLS connections
    • GMCP support
    • MCCP2 support (compress2)
  • Lua scripting:
    • Output and sending
    • Aliases
    • Triggers
    • GMCP hooks and sending
    • Timers
    • Customizing status bar
    • Persistent storage
    • Keybindings
  • Low resource and fast
  • In client help and manuals
  • Tab completion

Compiling

  • Install rust
  • Run cargo build to compile
  • Run cargo run to run

Installation

  • Ubuntu/Debian : Deb packages can be found on the releases page
  • Archlinux/Manjaro : Packages are available on AUR
  • Mac/Homebrew : We have a homebrew tap brew tap LiquidityC/blightmud
  • Other/Alternative : Download source and run cargo install --path . from the project root

Support, questions and help

Join our discord

Contributing

All contributions are welcome. Check out contributing guidelines.

Contributors

Side notes

This is my first rust project that has actually grown a bit. Some things might look silly but thanks to rust they should still be safe. Anywho. If you find some antipattern where you have a better idea I'm more then happy to se the PR and learn some more rustier ways.

About

A terminal mud client written in Rust

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 90.5%
  • Lua 9.5%