{"id":13697690,"url":"https://github.com/Blightmud/Blightmud","last_synced_at":"2025-05-03T20:30:53.474Z","repository":{"id":36960961,"uuid":"258866028","full_name":"Blightmud/Blightmud","owner":"Blightmud","description":"A terminal mud client written in Rust","archived":false,"fork":false,"pushed_at":"2025-04-18T17:03:31.000Z","size":20083,"stargazers_count":234,"open_issues_count":9,"forks_count":59,"subscribers_count":9,"default_branch":"dev","last_synced_at":"2025-04-19T05:38:07.017Z","etag":null,"topics":["hacktoberfest","linux","lua","mac","mud","mud-client","rust","rust-lang","terminal","terminal-based","vt102"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Blightmud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"LiquidityC","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-04-25T20:18:22.000Z","updated_at":"2025-04-18T17:03:34.000Z","dependencies_parsed_at":"2024-04-08T02:53:57.858Z","dependency_job_id":"ae527ab9-98e7-48ad-9501-3b67f7583e52","html_url":"https://github.com/Blightmud/Blightmud","commit_stats":null,"previous_names":["liquidityc/blightmud"],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blightmud%2FBlightmud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blightmud%2FBlightmud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blightmud%2FBlightmud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Blightmud%2FBlightmud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Blightmud","download_url":"https://codeload.github.com/Blightmud/Blightmud/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252252579,"owners_count":21718765,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","linux","lua","mac","mud","mud-client","rust","rust-lang","terminal","terminal-based","vt102"],"created_at":"2024-08-02T18:01:01.606Z","updated_at":"2025-05-03T20:30:48.464Z","avatar_url":"https://github.com/Blightmud.png","language":"Rust","funding_links":["https://ko-fi.com/LiquidityC"],"categories":["Clients"],"sub_categories":[],"readme":"![Rust](https://github.com/Blightmud/Blightmud/workflows/Test%20\u0026%20Build/badge.svg)\n![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/blightmud/blightmud/latest?sort=semver)\n![GitHub issues by-label](https://img.shields.io/github/issues-raw/blightmud/blightmud/bug)\n[![dependency status](https://deps.rs/repo/github/blightmud/blightmud/status.svg)](https://deps.rs/repo/github/blightmud/blightmud)\n![Security audit](https://github.com/Blightmud/blightmud/workflows/Security%20audit/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/Blightmud/Blightmud/badge.svg?branch=dev)](https://coveralls.io/github/Blightmud/Blightmud?branch=dev)\n[![Discord](https://img.shields.io/discord/712214526463836191?label=Discord)](https://discord.gg/qnxgUC5)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"300\" height=\"300\" src=\"resources/images/logo.png\"\u003e\n\u003c/p\u003e\n\n# Blightmud  : A mud client for the terminal\n\nBlightmud has been a passion project of mine for some time. A big user of the\nold but great [tinyfugue](http://tinyfugue.sourceforge.net/) I always wanted to\ncreate my own similar mud client. Even though I don't play much muds these\ndays.\n\n## The name?\n\nThe client is written in rust. Some navigating throught the thesaurus brought\nme to the word **blight** and here we are.\n\n## Features\n\n- Completely terminal based (mac and linux)\n- Telnet:\n  - TLS\n  - GMCP\n  - MSDP\n  - MCCP2 (compress2)\n  - NAWS\n  - TTYPE\n  - TELNET CHARSET\n  - MSSP\n- Lua scripting:\n  - Output and sending\n  - Aliases\n  - Triggers\n  - Timers\n  - Customizing status bar\n  - Persistent storage\n  - Session storage\n  - Keybindings\n  - Audio playback (music/ambiance and sound effects)\n  - Text-To-Speech\n  - Mouse scrolling\n  - Plugins\n  - Sockets (TCP connecting and sending only)\n  - Spellchecking\n- Low resource and fast\n- In client help and manuals\n- Native Text-To-Speech functionality (optional compile)\n- Text searching\n- Tab completion\n- Split view when scrolling\n- Screen reader friendly mode\n\n## Demo\n\n![screenshot](resources/images/demo.gif)\n\n## Installation\n\n- **Ubuntu/Debian**      : Deb packages can be found on the releases page\n- **Archlinux/Manjaro**  : Packages are available on [AUR](https://aur.archlinux.org/packages/?O=0\u0026K=blightmud)\n- **NixOS/Nix**          : Packages are available in [NixPkgs](https://search.nixos.org/packages?channel=unstable\u0026from=0\u0026size=50\u0026sort=relevance\u0026type=packages\u0026query=blightmud), or from our [Flake](flake.nix)\n- **Mac/Homebrew**       : We have a homebrew tap `brew tap Blightmud/blightmud` (intel only, if you're on Apple Silicon (darwin) compiling is the best option)\n- **Cargo**              : If you have rust installed just run `cargo install --git https://github.com/blightmud/blightmud blightmud` from your favourite terminal.\n- **Other/Alternative**  : Download source and run `cargo install --path .` from the project root\n- **Windows**            : No native windows support but Blightmud runs fine under WSL\n\n## Compiling\n\n- Install rust\n- Run `cargo build` to compile\n- Run `cargo run` to run\n\nDependencies include, openssl, alsa-libs and pkg-config\n- Ubuntu    `apt install pkg-config libopenssl-dev libasound2-dev libclang-dev`\n- Arch      `pacman -S pkgconf alsa-lib openssl clang`\n\n### Compile with text-to-speech\n\n- Install rust\n- Run `cargo build --all-features` to compile\n- Run `cargo run --all-features` to run\n\nIn order for this to build correctly you will need to install some additional\ndev dependencies: **libclang** and **libspeechd**. Below are some installation\ncommands that might fit your system:\n\n- Ubuntu    `apt install libclang-dev libspeechd-dev speech-dispatcher speech-dispatcher-espeak espeak`\n- Arch      `pacman -S speech-dispatcher espeak`\n\n### Compile without spellchecking\n\nSome users may encounter issues building the spellcheck feature on MacOS ARM64 (M1/M2). To\nbuild Blightmud without the spellcheck feature, use `--no-default-features`. E.g.:\n\n- Install rust\n- Run `cargo build --no-default-features` or `cargo build --no-default-features --features text-to-speech`\n- Run `cargo run --no-default-features` or `cargo run --no-default-features --features text-to-speech` to run\n\n### Nix\n\nIf you're using [Nix](https://nixos.org/) or NixOS you can try Blightmud\nright away with:\n\n- `nix run github:blightmud/blightmud`\n\nFor developers, once you've cloned this repo you can use the \n[Blightmud flake](flake.nix) directly, or with [direnv](https://direnv.net/), to\nhave a ready-to-go and self-contained build environment:\n\n- Run `nix build` to build Blightmud without text to speech.\n- Run `nix build .#blightmud-tts` to build Blightmud with text to speech.\n- Run `nix develop` to enter a dev. env. with Rust nightly.\n- Run `nix develop .#stable` to enter a dev. env. with the latest stable Rust.\n\n## Support, questions and help\n\nJoin our [discord](https://discord.gg/qnxgUC5) post an [issue](https://github.com/Blightmud/Blightmud/issues/new/choose) or post a question in [discussions](https://github.com/Blightmud/Blightmud/discussions)\n\n## Contributing\n\nAll contributions are welcome. Check out [contributing guidelines](CONTRIBUTING.md).\n\n## Side notes\n\nThis is my first rust project that has actually grown a bit. Some things might\nlook silly but thanks to rust they should still be safe. Anywho. If you find\nsome antipattern where you have a better idea I'm more then happy to se the PR\nand learn some more rustier ways.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlightmud%2FBlightmud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBlightmud%2FBlightmud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBlightmud%2FBlightmud/lists"}