- 1 Introduction
- 2 Downloads
- 3 Running Axmud
- 4 Installation on MS Windows
- 5 Installation on Linux
- 5.1 Installation on Linux using the .DEB package
- 5.2 Installation on Linux using the .RPM package
- 5.3 Installation on Linux from source
- 5.3.1 Installation on Arch-based systems
- 5.3.2 Installation on Debian-based systems
- 5.3.3 Installation on Fedora
- 5.3.4 Installation on Manjaro
- 5.3.5 Installation on openSUSE
- 5.3.6 Installation on Red Hat Enterprise Linux / CentOS
- 6 Installation ON BSD
- 6.1 Installation on GhostBSD
- 7 List of pre-configured worlds
- 8 Contributing
- 9 Authors
- 10 License
Axmud is a modern Multi-User Dungeon (MUD) client written in Perl 5 / Gtk3. Its features include:
- Telnet, SSH and SSL connections
- ANSI/xterm/truecolour/OSC/RGB colours
- Full support for all major MUD protocols, including MXP and GMCP (with partial Pueblo support)
- Partial VT100 emulation
- Class-based triggers, aliases, macros, timers and hooks
- Graphical automapper
- Over 100 pre-configured worlds
- Multiple approaches to scripting
- Fully customisable from top to bottom, using the command line or the extensive GUI interface
- Native support for visually-impaired users
Axmud is known to work on MS Windows, Linux and *BSD. It might be possible to install it on other systems such as MacOS, but the authors have not been able to confirm this yet.
Axmud does not yet have a comprehensive manual, but there is lots of information to read:
- Read the quick help
- Read the Axmud guide, including the section for visually-impaired users
- Read the tutorial for the Axbasic scripting language
- In Axmud's main window menu, click Help > About
- Just below the menu, click the calendar button to open the data viewer window, and then click on Help
- Type ;help for a list of client commands, or ;help listworld for help on the ;listworld client command
- Type ;axbasichelp for a list of help topics for the Axbasic scripting language
- For further support, visit our Github page
Latest version: v2.0.0 (21 Jan 2024) (see recent changes)
Official packages (also available from the Github release page):
- MS Windows installer from Sourceforge
- DEB package (for Debian-based distros, e.g. Ubuntu, Linux Mint) from Sourceforge
- RPM package (for RHEL-based distros, e.g. Fedora) from Sourceforge
Source code:
- Source code from Sourceforge (see also the source code for MS Windows
- Source code and support from GitHub
There are several ways to install Axmud (see below). Most of them will add an Axmud icon to your desktop, and an entry in your Start Menu.
There are actually two versions of Axmud: a 'normal' version, and a version with optimised settings for visually-impaired users.
The optimised version will start talking at you, as soon as you start it. (If you don't hear anything, then perhaps there are no text-to-speech engines installed on your system.)
If you're running Axmud from the command line, visually-impaired users can run this script:
baxmud.pl
Other users can run this script:
axmud.pl
Using either script, you can specify a world to which Axmud connects immediately:
axmud.pl empiremud.net 4000
If you omit the port number, Axmud connects using the generic port 23:
axmud.pl elephant.org
If a world profile already exists, you can specify its name instead:
axmud.pl cryosphere
You can force Axmud to use a particular text-to-speech engine by adding the engine's name to the end of those commands. This overrides (almost) all other text-to-speech settings.
Acceptable engine names are 'espeak', 'esng' (for espeak-ng), 'flite' (for Festival Lite), 'festival', 'swift' and 'none' (for the dummy engine, which produces no sound). For example:
baxmud.pl empiremud.net 4000 esng axmud.pl cryosphere festival
Note that on MS Windows, Flite is not supported, and other speech engines are assumed to be installed in their default locations.
The easiest way to use Axmud on Windows is to download and run the Windows installer.
The installer contains everything you need to run Axmud, including all the required modules and libraries, and a copy of several text-to-speech engines.
Note that, as of 2020, the sisyphusion repository no longer exists, so there is no longer any known method for running Axmud with ActivePerl or with Strawberry Perl. If installing Axmud manually, you must use MSYS2. The method is described in the installation script.
Note also that, as of 2024, MSYS2 does not support versions of Windows earlier than 8.1, and does not support 32-bit Windows at all. Therefore, the latest version of Axmud will not run on those systems. (Earlier versions of Axmud, for example v1.3.029, should still work; you can download the installers from Sourceforge.)
There are three methods of installation on Linux - install using the .deb package, install using the .rpm package or install manually using the source code.
.deb packages are typically supported on Debian-based systems (such as Ubuntu and Linux Mint).
Installation may be as simple as downloading the .deb package and double-clicking on it. If not, you can install the package from the command line.
Open a terminal and navigate to the directory where the downloaded file is, for example:
cd Downloads
Then install the package:
sudo dpkg -i libgames-axmud-perl_X.Y.ZZZ.deb
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
sudo dpkg -i libgames-axmud-perl_1.2.345.deb
When installation is complete, start Axmud by typing:
axmud.pl
.rpm packages are typically supported on Fedora-based systems (such as Red Hat Enterprise Linux and CentOS).
The package can be installed from the command line.
Open a terminal and navigate to the directory where the downloaded file is, for example:
** cd Downloads**
Then install the package:
sudo yum localinstall perl-Games-Axmud-X.Y.ZZZ.noarch.rpm
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
sudo yum localinstall perl-Games-Axmud-1.2.345.noarch.rpm
When installation is complete, start Axmud by typing:
axmud.pl
Manual installation is quite simple on most modern Linux systems.
This document contains complete instruction for some of the most popular distros:
- Arch-based systems (such as Arch Linux)
- Debian-based systems (such as Debian, Ubuntu and Linux Mint)
- Fedora
- Manjaro
- openSUSE (see below)
- Red Hat Enterprise Linux and CentOS
Axmud v1.2.0 (and later versions) cannot easily be easily installed on openSUSE, as the required graphics library (Gtk3) is not yet available through openSUSE's software repositories. We suggest that you continue using Axmud v1.1.405 for the time being.
(These instructions have been tested on Arch Linux. For Manjaro, see the section below.)
First, download the source code from the Axmud website (the most recent file ending .tar.gz).
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz cd Games-Axmud-X.Y.ZZZ
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
tar -pzxvf Games-Axmud-1.2.345.tar.gz cd Games-Axmud-1.2.345
Make sure you have the right dependencies:
sudo pacman -S gtk3 perl-gtk3 goocanvas wmctrl sudo pacman -S perl-cpanplus-dist-arch setupdistarch sudo cpanp i Archive::Zip File::Copy::Recursive File::HomeDir File::ShareDir File::ShareDir::Install Glib Gtk3 GooCanvas2 IO::Socket::INET6 IPC::Run JSON Math::Round Net::OpenSSH Path::Tiny Regexp::IPv6
At the time of writing, there are some issues with installing certain libraries on Arch. If you know that those issues have been fixed, you can type this command to allow Axmud to use SSL connections:
sudo cpanp i IO::Socket::SSL
If you want to use sound effects and/or text-to-speech, you should also type:
sudo pacman -S sox timidity++ espeak-ng
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
Axmud's default text-to-speech engine is eSpeak but, at the time of writing, there are some issues with its installation on Arch systems. Assuming that an alternative speech engine has been installed using the instructions just above, visually-impaired users should start Axmud by typing this, the first time:
baxmud.pl esng
Once Axmud has started, type the following commands, which replace Axmud's default speech engine with espeak-ng:
;config all engine esng ;save
Thereafter, visually-impaired users can start Axmud by typing:
baxmud.pl
(These instructions have been tested on Debian, Ubuntu and Linux Mint.)
First, download the source code from the Axmud website (the most recent file ending .tar.gz).
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud*.tar.gz
cd Games-Axmud*
Make sure you have the right dependencies:
sudo apt-get update sudo apt-get install build-essential libgtk3-perl libgoocanvas-2.0-dev wmctrl sudo cpan install Archive::Extract File::HomeDir File::ShareDir File::ShareDir::Install GooCanvas2 JSON Math::Round Net::OpenSSH Path::Tiny Regexp::IPv6
If you want to use sound effects and/or text-to-speech, you should also type:
sudo apt-get install libsox-fmt-all timidity
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
First, download the source code from the Axmud website (the most recent file ending .tar.gz).
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz cd Games-Axmud-X.Y.ZZZ
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
tar -pzxvf Games-Axmud-1.2.345.tar.gz cd Games-Axmud-1.2.345
Make sure you have the right dependencies:
sudo rpm --import http://li.nux.ro/download/nux/RPM-GPG-KEY-nux.ro sudo rpm -Uvh http://li.nux.ro/download/nux/dextop/el7/x86_64/nux-dextop-release-0-1.el7.nux.noarch.rpm sudo dnf install cpan sudo dnf install 'perl(Archive::Extract)' 'perl(File::Copy::Recursive)' 'perl(File::Fetch)' 'perl(File::HomeDir)' 'perl(File::ShareDir)' 'perl(File::ShareDir::Install)' 'perl(Glib)' 'perl(Gtk3)' 'perl(GooCanvas2)' 'perl(IO::Socket::INET6)' 'perl(IPC::Run)' 'perl(JSON)' 'perl(Math::Round)' 'perl(Net::OpenSSH)' 'perl(Path::Tiny)' 'perl(Regexp::IPv6)' 'perl(Time::Piece)'
If you want to use sound effects and/or text-to-speech, you should also type:
sudo dnf install sox timidity++
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
Manjaro's rolling release version is affected by a recurring issue (Perl modules are not updated when the Perl itself is updated, meaning that any Perl applications will immediately stop working). If you're using the rolling release version, consider installing via Perl homebrew instead.
These instructions work on both the stable and rolling releases of Manjaro.
First, download the source code from the Axmud website (the most recent file ending .tar.gz).
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz cd Games-Axmud-X.Y.ZZZ
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
tar -pzxvf Games-Axmud-1.2.345.tar.gz cd Games-Axmud-1.2.345
Make sure you have the right dependencies:
sudo pacman -S base-devel gtk3 goocanvas perl-gtk3 perl-goocanvas2 wmctrl cpanminus sudo cpanm Archive::Extract File::Copy::Recursive File::HomeDir File::ShareDir File::ShareDir::Install Glib IO::Socket::INET6 IO::Socket::SSL IPC::Run JSON Math::Round Net::OpenSSH Path::Tiny Regexp::IPv6 sudo cpanm Archive::Zip --force
If you want to use sound effects and/or text-to-speech, you should also type:
sudo pacman -S sox timidity++
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
Axmud v1.2.0 (and later versions) cannot easily be easily installed on openSUSE, as the required graphics library (Gtk3) is not yet available through openSUSE's software repositories. We suggest that you continue using Axmud v1.1.405 for the time being.
First, download the source code from the Axmud website (the most recent file ending .tar.gz).
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz cd Games-Axmud-X.Y.ZZZ
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
tar -pzxvf Games-Axmud-1.2.345.tar.gz cd Games-Axmud-1.2.345
Now we need to add an extra repository. First get the key:
sudo rpm --import http://li.nux.ro/download/nux/RPM-GPG-KEY-nux.ro
Then add the repository. On CentOS/RHEL 6, do this:
sudo rpm -Uvh http://li.nux.ro/download/nux/dextop/el6/x86_64/nux-dextop-release-0-2.el6.nux.noarch.rpm
On CentOS/RHEL 7, do this:
sudo rpm -Uvh http://li.nux.ro/download/nux/dextop/el7/x86_64/nux-dextop-release-0-1.el7.nux.noarch.rpm
Now make sure you have the right dependencies:
sudo yum groupinstall 'Development Tools' sudo yum install epel-release cpan goocanvas2 wmctrl sudo yum install 'perl(Archive::Extract)' 'perl(Archive::Tar)' 'perl(Archive::Zip)' 'perl(File::Copy::Recursive)' 'perl(File::Fetch)' 'perl(File::HomeDir)' 'perl(File::ShareDir)' 'perl(File::ShareDir::Install)' 'perl(Glib)' 'perl(Gtk3)' 'perl(IO::Socket::INET6)' 'perl(IPC::Run)' 'perl(JSON)' 'perl(Math::Round)' 'perl(Net::OpenSSH)' 'perl(Path::Tiny)' 'perl(Regexp::IPv6)' 'perl(Time::Piece)' sudo cpan install GooCanvas2
If you want to use sound effects and/or text-to-speech, you should also type:
sudo yum install sox libtimidity
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
Manual installation using the source code is quite simple on BSD. (At the time of writing, no installer is available).
(These instructions have been tested on GhostBSD, which is based on FreeBSD. It's likely that installation instructions are the same or very similar on all distros based on FreeBSD, OpenBSD or NetBSD.)
Open a terminal window and navigate to the directory containing the downloaded file, for example:
cd Downloads
Decompress the .tar.gz file:
tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz cd Games-Axmud-X.Y.ZZZ
You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:
tar -pzxvf Games-Axmud-1.2.345.tar.gz cd Games-Axmud-1.2.345
Make sure you have the right dependencies:
sudo pkg install goocanvas2 wmctrl sudo cpan install Archive::Extract Archive::Zip File::Copy::Recursive File::HomeDir File::ShareDir File::ShareDir::Install Glib Gtk3 GooCanvas2 IO::Socket::INET6 IO::Socket::SSL IPC::Run JSON Math::Round Net::OpenSSH Path::Tiny Regexp::IPv6
If you want to use sound effects and/or text-to-speech, you should also type:
sudo pkg install sox timidity++
Then install Axmud itself:
perl Makefile.PL make sudo make install
When installation is complete, start Axmud by typing:
axmud.pl
Axmud can be used with any world that supports telnet, SSH or SSL connections. The following pre-configured worlds have already been set up to use the automapper, handle connections and so on.
- 3-Kingdoms (Mudstats page)
- 3-Scapes (Mudstats page)
- 4Dimensions (Mudstats page)
- Aardwolf MUD (Mudstats page)
- Achaea, Dreams of Divine Lands (Mudstats page)
- Adventures Unlimited (Mudstats page)
- Aetolia, the Midnight Age (Mudstats page)
- Age of Chaos (Mudstats page)
- Alter Aeon (Mudstats page)
- Ancient Anguish (Mudstats page)
- Archipelago MUD
- ArcticMud (Mudstats page)
- Avalon (Germany) (Mudstats page)
- Avalon: The Legend Lives (Mudstats page)
- Avatar MUD (Mudstats page)
- BatMUD (Mudstats page)
- Bedlam (Mudstats page)
- Burning MUD (Mudstats page)
- Bylins MUD
- CLOK (Mudstats page)
- Carrion Fields (Mudstats page)
- Clessidra MUD (Top Mud Sites page)
- CoffeeMud (Mudstats page)
- Cryosphere (Mudstats page)
- CyberASSAULT (Mudstats page)
- Dark Realms: City of Syne
- Dark and Shattered Lands (Mudstats page)
- DartMUD (Mudstats page)
- Dawn (Mudstats page)
- Dead Souls Dev (Mudstats page)
- Dead Souls Local (Mudstats page)
- Dead Souls Prime (Mudstats page)
- Discworld MUD (Mudstats page)
- Dragon Swords (Mudstats page)
- DragonStone (Mudstats page)
- DuneMUD (Mudstats page)
- Duris: Land of BloodLust (Mudstats page)
- Elephant MUD (Mudstats page)
- Elysium RPG (Top Mud Sites page)
- EmpireMUD 2.0 (Mudstats page)
- End of the Line (Mudstats page)
- Eternal Darkness (Mudstats page)
- Forest's Edge
- Forgotten Kingdoms (Mudstats page)
- Genesis (Mudstats page)
- Godwars: Rebirth of Apocalypse (Mudstats page)
- GreaterMUD (Mudstats page)
- HellMOO (Mudstats page)
- HexOnyx (Top Mud Sites page)
- HolyQuest (Mudstats page)
- Iberia MUD (Mudstats page)
- Icesus (Mudstats page)
- ifMUD (Mudstats page)
- Imperian: Sundered Heavens (Mudstats page)
- Islands (Mudstats page)
- LambdaMOO (Mudstats page)
- LegendMUD (Mudstats page)
- Legends of Kallisti (Mudstats page)
- Lost Souls (Mudstats page)
- Lowlands
- Luminari MUD (Mudstats page)
- Lusternia: Age of Ascension (Mudstats page)
- MUD1 (British Legends) (Mudstats page)
- MUD2 (Canadian server) (Mudstats page)
- MUD2 (UK server) (Mudstats page)
- MUME - Multi Users In Middle Earth (Mudstats page)
- Materia Magica (Mudstats page)
- Medievia (Mudstats page)
- Merentha (Mudstats page)
- Midnight Sun (Mudstats page)
- Miriani (Mudstats page)
- MorgenGrauen (Mudstats page)
- NannyMUD (Mudstats page)
- Nanvaent (Mudstats page)
- New Worlds: Ateraan (Mudstats page)
- Nodeka (Mudstats page)
- Nuclear War (Mudstats page)
- Penultimate Destination (Mudstats page)
- Pict MUD (Mudstats page)
- RavenMUD (Mudstats page)
- Realms of Despair (Mudstats page)
- Realms of Wonder (Top Mud Sites page)
- RealmsMUD (Mudstats page)
- Reinos de Leyenda (Mudstats page)
- RetroMUD (Mudstats page)
- RoninMUD (Mudstats page)
- Rupert (Mudstats page)
- SlothMUD III (Mudstats page)
- Star Wars Mud (Mudstats page)
- StickMUD (Mudstats page)
- Stonia (Top Mud Sites page)
- Tempora Heroica
- The Inquisition: Legacy (Mudstats page)
- The Land (Mudstats page)
- The Two Towers (Mudstats page)
- The Unofficial SquareSoft MUD (Mudstats page)
- The Wheel of Time MUD (Mudstats page)
- TorilMUD (Mudstats page)
- Tsunami (Mudstats page)
- Valhalla MUD (Mudstats page)
- Viking MUD (Mudstats page)
- Waterdeep (Mudstats page)
- ZombieMUD (Mudstats page)
- Report a bug: Use the Github issues page.
See the AUTHORS file.
Axmud is licensed under the GNU General Public License v3.0.
✨🍰✨