view release on metacpan or  search on metacpan

README.rst  view on Meta::CPAN

* `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`_

1 Introduction
==============

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 <share/docs/quick/quick.mkd>`__
- Read the `Axmud guide <share/docs/guide/index.mkd>`__, including the section for `visually-impaired users <share/docs/guide/ch16.mkd>`__
- Read the `tutorial <share/docs/tutorial/index.mkd>`__  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 <https://github.com/axcore/axmud>`__

2 Downloads
===========

Latest version: **v2.0.0 (21 Jan 2024)** (see `recent changes <CHANGES>`__)

Official packages (also available from the `Github release page <https://github.com/axcore/tartube/releases>`__):

- `MS Windows installer <https://sourceforge.net/projects/axmud/files/Axmud-2.0.0/install-axmud-2.0.0.exe/download>`__ from Sourceforge
- `DEB package (for Debian-based distros, e.g. Ubuntu, Linux Mint) <https://sourceforge.net/projects/axmud/files/Axmud-2.0.0/libgames-axmud-perl_2.0.0.deb/download>`__ from Sourceforge
- `RPM package (for RHEL-based distros, e.g. Fedora) <https://sourceforge.net/projects/axmud/files/Axmud-2.0.0/perl-Games-Axmud-2.0.0.noarch.rpm/download>`__ from Sourceforge

Source code:

- `Source code <https://sourceforge.net/projects/axmud/files/Axmud-2.0.0/Games-Axmud-2.0.0.tar.gz/download>`__ from Sourceforge (see also the source code for `MS Windows <https://sourceforge.net/projects/axmud/files/Axmud-2.0.0/Games-Axmud-2.0.0.tar....
- `Source code <https://github.com/axcore/axmud>`__ and `support <https://github.com/axcore/axmud/issues>`__ from GitHub

3 Running Axmud
===============

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.

4 Installation on MS Windows
============================

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 <https://sisyphusion.tk/>`__ 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 <htt...

Note also that, as of 2024, `MSYS2 <https://www.msys2.org/>`__ 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 versi...

5 Installation on Linux
=======================

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.

5.1 Installation on Linux using the .DEB package
------------------------------------------------

**.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**