5111509577
<!-- Keep the title short & concise so anyone non-technical can
understand it,
the title appears in PTB changelogs -->
#### Brief overview of PR changes/additions
Trial a new project guideline for the codebase - no TODOs in the code.
#### Motivation for adding to Mudlet
We've added 100+ TODOs to the codebase over the 10+ years of Mudlet and
have barely resolved any of them. They just don't add any value by
sitting around, and nobody historically has taken an interest in going
through and resolving them.
#### Other info (issues closed, discussion etc)
Let's revisit on 1 Jan 2023 if this guideline still makes sense and we'd
like to keep it.
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| .vscode | ||
| 3rdparty | ||
| CI | ||
| cmake | ||
| docker | ||
| src | ||
| templates | ||
| test | ||
| translations | ||
| .appveyor.yml | ||
| .clang-tidy | ||
| .crowdin.yml | ||
| .gitignore | ||
| .gitmodules | ||
| .imgbotconfig | ||
| CMakeLists.txt | ||
| COMMITMENT | ||
| COMPILE | ||
| COPYING | ||
| CPPLINT.cfg | ||
| dangerfile.js | ||
| icon_1024x1204.png | ||
| icon_dev_1024x1204.png | ||
| icon_ptb_1024x1204.png | ||
| mudlet.desktop | ||
| mudlet.png | ||
| mudlet.svg | ||
| README.md | ||
| setup-windows-sdk.ps1 | ||
Mudlet
Play immersive, multiplayer, pure-text RPGs on Mudlet.
Windows:
Linux & MacOS:
About • Key Features • Download • How To Use • Roadmap • Credits • License
About
Mudlet is a quality MUD client, designed to take mudding to a new level.
It’s a modern breed of a client on the gaming scene – with an intuitive user interface, a specially designed scripting framework, and a very fast text display. That, along with cross-platform capability and an open-source development model result in a very likable game client.
Key Features
- Simple to use
- Very, very fast
- Active development
- Big, thriving community
- Powerful trigger engine
- Rich Lua-based coding functionality (API)
- Excellent script editor
- 2D and 3D mapper with autowalk
- Powerful and simple to use GMCP
- Discord integration
- Completely themable
- Open-source and Free
- Cross platform: runs on Windows, macOS and Linux
- Full compatibility: run same scripts on any of the above
Explain?
Easy to use client
We’re big on usability, and as such, creating an easy to use client and interface is one of the defining goals of the project. This applies to both the power users and usual gamers – everyone will feel at home with Mudlet, without having to waste too much time figuring out how to do something.
Designed for speed
Mudlet is designed and built to be very fast and efficient right from the start. Its scripting engine is designed to scale to large systems without bogging down – and the text display is designed to handle thousands of lines in under a second. All in all, we are very serious about Mudlet being quick – and take all measures to make it so.
Powerful Scripting
Mudlet features a scripting framework using Lua – a small, fast and efficient scripting language. This allows Mudlet to leverage the existing community and large ecosystem of existing packages for Lua without the many drawbacks of creating a Mudlet specific scripting language. Best of all, the Lua API is seamlessly integrated in Mudlet and shared by all aliases, triggers, scripts, keybindings, buttons and other Mudlet components.
Cross-Platform love
We believe in making Mudlet available to people on all major platforms, and we work on keeping cross-platform compatibility right from start. Mudlet is available on Linux (both 32bit and 64bit), Windows, and macOS; you may be able to run it on additional platforms as well.
Download
Download for free from mudlet.org
How To Use
- Download and double-click on Mudlet to run
- Pick an existing game and hit
Connect - ... or play one of your choosing:
- Click
New - Enter
Server addressandPortof your game (found on the game's website, e.g.mygame.comand2003) - Pick a
Profile name - Hit
Connect
- Click
Vision
Mudlet's vision is to build the best text gaming experience possible to nurture & grow this niche scene.
Roadmap
See the project's roadmap to get an idea of where it's headed, as well as contribute!
Credits
Author: Mudlet Makers. Join in, contributions are welcome!
This software wouldnt've been possible without these open source packages:
- Qt
- Lua
- PCRE
- edbee
- DBLSQD
- argparse
- Boost Graph Library
- Busted
- Ccache
- Communi
- Hunspell
- lua-http
- lua-yajl
- lua-zip
- LuaFileSystem
- Luarocks
- LuaSQL
- luautf8
- pugixml
- SQLite
- vcpkg
- yajl
Credit to Markdownify for the README inspiration.
License
GPL2+