share/docs/guide/ch02.html

<!doctype html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<style type="text/css">
td, th { border: 1px solid #c3c3c3; padding: 0 3px 0 3px; }
table { border-collapse: collapse; }
img { max-width: 100%; }
</style>
<meta name="generator" content="ReText 7.2.3">
<title>ch02</title>
<style type="text/css">
</style>
</head>
<body>
<p><a href="ch01.html">Previous</a> <a href="index.html">Index</a> <a href="ch03.html">Next</a></p>
<hr>
<h1>2 Installing Axmud</h1>
<h4>Table of Contents</h4>
<ul>
<li><a href="#2.1">2.1 Downloading Axmud</a></li>
<li><a href="#2.2">2.2 Installation on MS Windows</a></li>
<li><a href="#2.3">2.3 Installation on Linux</a><ul>
<li><a href="#2.3.1">2.3.1 Installation on Linux using the .DEB package</a></li>
<li><a href="#2.3.2">2.3.2 Installation on Linux using the .RPM package</a></li>
</ul>
</li>
<li><a href="#2.4">2.4 Installation on Linux from source</a><ul>
<li><a href="#2.4.1">2.4.1 Installation on Arch-based systems</a></li>
<li><a href="#2.4.2">2.4.2 Installation on Debian-based systems</a></li>
<li><a href="#2.4.3">2.4.3 Installation on Fedora</a></li>
<li><a href="#2.4.4">2.4.4 Installation on Manjaro</a></li>
<li><a href="#2.4.5">2.4.5 Installation on openSUSE</a></li>
<li><a href="#2.4.6">2.4.6 Installation on Red Hat Enterprise Linux / Cent</a></li>
</ul>
</li>
<li><a href="#2.5">2.5 Installation on *BSD</a><ul>
<li><a href="#2.5.1">2.5.1 Installation on GhostBSD</a></li>
</ul>
</li>
</ul>
<hr>
<p>Axmud is known to work on MS Windows, Linux and *BSD. It might be possible to install Axmud on macOS, but the authors have not been able to confirm this yet.</p>
<h2><a name="2.1">2.1 Downloading Axmud</a></h2>
<p>The most recent release is available from the Axmud website:</p>
<pre><code>    https://axmud.sourceforge.io
</code></pre>
<p>The source code can also be obtained from using git:</p>
<pre><code>    https://github.com/axcore/axmud
</code></pre>
<h2><a name="2.2">2.2 Installation on MS Windows</a></h2>
<p>The easiest way to use Axmud on Windows is to download and run the Windows installer.</p>
<p>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.</p>
<p>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, <em>../nsis/axmud_install.nsi</em>.</p>
<p>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, <strong>the latest version of Axmud will not run on those systems</strong>. (Earlier versions of Axmud, for example v1.3.029, should still work; you can download the installers from Sourceforge.)</p>
<h2><a name="2.3">2.3 Installation on Linux</a></h2>
<p>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.</p>
<h3><a name="2.3.1">2.3.1 Installation on Linux using the .DEB package</a></h3>
<p>.deb packages are typically supported on Debian-based systems (such as Ubuntu and Linux Mint).</p>
<p>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.</p>
<p>Open a terminal and navigate to the directory where the downloaded file is, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Then install the package:</p>
<pre><code>    sudo dpkg -i libgames-axmud-perl_X.Y.ZZZ.deb
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:</p>
<pre><code>    sudo dpkg -i libgames-axmud-perl_1.2.345.deb
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h3><a name="2.3.2">2.3.2 Installation on Linux using the .RPM package</a></h3>
<p>.rpm packages are typically supported on Fedora-based systems (such as Red Hat Enterprise Linux and CentOS).</p>
<p>The package can be installed from the command line.</p>
<p>Open a terminal and navigate to the directory where the downloaded file is, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Then install the package:</p>
<pre><code>    sudo yum localinstall perl-Games-Axmud-X.Y.ZZZ.noarch.rpm
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:</p>
<pre><code>    sudo yum localinstall perl-Games-Axmud-1.2.345.noarch.rpm
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h2><a name="2.4">2.4 Installation on Linux from source</a></h2>
<p>Manual installation is quite simple on most modern Linux systems.</p>
<p>This chapter contains complete instruction for some of the most popular distros:</p>
<ul>
<li>Arch-based systems (such as Arch Linux)</li>
<li>Debian-based systems (such as Debian, Ubuntu and Linux Mint)</li>
<li>Fedora</li>
<li>Manjaro</li>
<li>OpenSUSE (see below)</li>
<li>Red Hat Enterprise Linux and CentOS</li>
</ul>
<p>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.</p>
<h3><a name="2.4.1">2.4.1 Installation on Arch-based systems</a></h3>
<p>(These instructions have been tested on Arch Linux. For Manjaro, see the Section below.)</p>
<p>First, download the source code from the Axmud website (the most recent file ending .tar.gz).</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz
    cd Games-Axmud-X.Y.ZZZ
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:</p>
<pre><code>    tar -pzxvf Games-Axmud-1.2.345.tar.gz
    cd Games-Axmud-1.2.345
</code></pre>
<p>Make sure you have the right dependencies:</p>
<pre><code>    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 IO::Socket::SSL IPC::Run JSON Net::OpenSSH Path::Tiny Regexp::IPv6 X11::WMCtrl
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo pacman -S sox timidity++
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h3><a name="2.4.2">2.4.2 Installation on Debian-based systems</a></h3>
<p>(These instructions have been tested on Debian, Ubuntu and Linux Mint.)</p>
<p>First, download the source code from the Axmud website (the most recent file ending .tar.gz).</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud.*.tar.gz
    cd Games-Axmud*
</code></pre>
<p>Make sure you have the right dependencies:</p>
<pre><code>    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 Net::OpenSSH Path::Tiny Regexp::IPv6 X11::WMCtrl
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo apt-get install libsox-fmt-mp3 timidity
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h3><a name="2.4.3">2.4.3 Installation on Fedora</a></h3>
<p>First, download the source code from the Axmud website (the most recent file ending .tar.gz).</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz
    cd Games-Axmud-X.Y.ZZZ
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:</p>
<pre><code>    tar -pzxvf Games-Axmud-1.2.345.tar.gz
    cd Games-Axmud-1.2.345
</code></pre>
<p>Make sure you have the right dependencies:</p>
<pre><code>    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(Net::OpenSSH)' 'perl(Path::Tiny)' 'perl(Regexp::IPv6)' 'perl(Time::Piece)'
    sudo cpan install X11::WMCtrl
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo dnf install sox timidity++
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h3><a name="2.4.4">2.4.4 Installation on Manjaro</a></h3>
<p>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 (see https://perlbrew.pl/ )</p>
<p>These instructions work on both the stable and rolling releases of Manjaro.</p>
<p>First, download the source code from the Axmud website (the most recent file ending .tar.gz).</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz
    cd Games-Axmud-X.Y.ZZZ
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded, for example:</p>
<pre><code>    tar -pzxvf Games-Axmud-1.2.345.tar.gz
    cd Games-Axmud-1.2.345
</code></pre>
<p>Make sure you have the right dependencies:</p>
<pre><code>    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 Net::OpenSSH Path::Tiny Regexp::IPv6
    sudo cpanm Archive::Zip --force
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo pacman -S sox timidity++
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h3><a name="2.4.5">2.4.5 Installation on openSUSE</a></h3>
<p>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.</p>
<h3><a name="2.4.6">2.4.6 Installation on Red Hat Enterprise Linux / CentOS</a></h3>
<p>First, download the source code from the Axmud website (the most recent file ending .tar.gz).</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz
    cd Games-Axmud-X.Y.ZZZ
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded,
for example:</p>
<pre><code>    tar -pzxvf Games-Axmud-1.2.345.tar.gz
    cd Games-Axmud-1.2.345
</code></pre>
<p>Now we need to add an extra repository. First get the key:</p>
<pre><code>    sudo rpm --import http://li.nux.ro/download/nux/RPM-GPG-KEY-nux.ro
</code></pre>
<p>Then add the repository. On CentOS/RHEL 6, do this:</p>
<pre><code>    sudo rpm -Uvh http://li.nux.ro/download/nux/dextop/el6/x86_64/nux-dextop-release-0-2.el6.nux.noarch.rpm
</code></pre>
<p>On CentOS/RHEL 7, do this:</p>
<pre><code>    sudo rpm -Uvh http://li.nux.ro/download/nux/dextop/el7/x86_64/nux-dextop-release-0-1.el7.nux.noarch.rpm
</code></pre>
<p>Now make sure you have the right dependencies:</p>
<pre><code>    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(Net::OpenSSH)' 'perl(Path::Tiny)' 'perl(Regexp::IPv6)' 'perl(Time::Piece)'
    sudo cpan install GooCanvas2 X11::WMCtrl
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo yum install sox timidity++
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<h2><a name="2.5">2.5 Installation on *BSD</a></h2>
<p>Manual installation using the source code is quite simple on *BSD. (At the time of writing, no installer is available).</p>
<h3><a name="2.5.1">2.5.1 Installation on GhostBSD</a></h3>
<p>(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.)</p>
<p>Open a terminal window and navigate to the directory containing the downloaded file, for example:</p>
<pre><code>    cd Downloads
</code></pre>
<p>Decompress the .tar.gz file:</p>
<pre><code>    tar -pzxvf Games-Axmud-X.Y.ZZZ.tar.gz
    cd Games-Axmud-X.Y.ZZZ
</code></pre>
<p>You must replace the X.Y.ZZZ with the actual version number you've downloaded,
for example:</p>
<pre><code>    tar -pzxvf Games-Axmud-1.2.345.tar.gz
    cd Games-Axmud-1.2.345
</code></pre>
<p>Make sure you have the right dependencies:</p>
<pre><code>    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 Net::OpenSSH Path::Tiny Regexp::IPv6 X11::WMCtrl
</code></pre>
<p>If you want to use sound effects and/or text-to-speech, you should also type:</p>
<pre><code>    sudo pkg install sox timidity++
</code></pre>
<p>Then install Axmud itself:</p>
<pre><code>    perl Makefile.PL
    make
    sudo make install
</code></pre>
<p>When installation is complete, start Axmud by typing:</p>
<pre><code>    axmud.pl
</code></pre>
<hr>
<p><a href="ch01.html">Previous</a> <a href="index.html">Index</a> <a href="ch03.html">Next</a></p>

</body>
</html>