Difference between revisions of "Installation on Linux"

From VCMI Project Wiki
Jump to: navigation, search
(Created page with links to .deb packages)
 
(Ubuntu)
 
(98 intermediate revisions by 11 users not shown)
Line 1: Line 1:
Warning: these packages are not yet tested. Use them with caution.
+
VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.
= Installation from packages =
+
= Binaries installation =
Install original game and WoG addon in this directory
+
== Ubuntu ==
 +
'''Latest stable build from PPA (recommended)'''
 +
 
 +
Up-to-date releases can be found in our PPA here: https://launchpad.net/~vcmi/+archive/ubuntu/ppa
 +
 
 +
To install VCMI from PPA use:
 +
<pre>
 +
sudo apt-add-repository ppa:vcmi/ppa
 +
sudo apt update
 +
sudo apt install vcmi
 +
</pre>
 +
 
 +
'''Unstable testing build from PPA'''
 +
 
 +
We also provide latest, unstable builds mostly suitable for testing here: https://launchpad.net/~vcmi/+archive/ubuntu/vcmi-latest
 +
 
 +
In order to install from this PPA use:
 +
<pre>
 +
sudo add-apt-repository ppa:vcmi/vcmi-latest
 +
sudo apt update
 +
sudo apt install vcmi
 +
</pre>
 +
 
 +
'''From Ubuntu repository'''
 +
 
 +
VCMI stable builds available in "multiverse" repository. Learn how to enable it in [https://help.ubuntu.com/community/Repositories/Ubuntu Ubuntu wiki].
 +
 
 +
Once enabled, you can install VCMI using Ubuntu Store or in terminal using following commands:
 +
<pre>
 +
sudo apt update
 +
sudo apt install vcmi
 +
</pre>
 +
 
 +
Note that version available in Ubuntu is outdated. Install via PPA is preferred.
 +
 
 +
== Debian ==
 +
 
 +
Stable VCMI version is available in "contrib" repository. Learn how to enable it in [https://wiki.debian.org/SourcesList Debian wiki].
 +
 
 +
To install VCMI from repository:
 +
<pre>
 +
sudo apt-get update
 +
sudo apt-get install vcmi
 +
</pre>
 +
<!-- DISABLED - SNAP PACKAGE IS OUTDATED
 +
== Snappy ==
 +
It's possible to install daily VCMI builds as distribution-agnostic Snap package:
 +
 
 +
* Visit [https://snapcraft.io/ snapcraft.io] to learn how to get Snappy on your distribution.
 +
* Once it's running install latest VCMI build with:
 +
<pre>
 +
sudo snap install --edge vcmi
 +
</pre>
 +
* After you can run VCMI with following commands:
 +
<pre>
 +
snap run vcmi.vcmilauncher
 +
snap run vcmi.vcmiclient
 +
snap run vcmi.vcmiserver
 +
</pre>
 +
* Keep in mind that instead of '''$HOME/.local/share/vcmi/''' you must copy Heroes 3 assets into:
 
<pre>
 
<pre>
/usr/share/vcmi/
+
$HOME/snap/vcmi/current/.local/share/vcmi/
 
</pre>
 
</pre>
This should give you such directory structure
+
* To update to latest version:
 
<pre>
 
<pre>
/usr/share/vcmi/Data
+
sudo snap refresh vcmi
/usr/share/vcmi/Mp3
 
/usr/share/vcmi/Maps
 
...
 
 
</pre>
 
</pre>
Install [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi-data.tar.gz VCMI data package] in the same directory.
 
  
+
'''Warning:''' Snap builds are currently in experimental state.
Download and install package for your distributive. To install package along with all dependencies:
+
 
 +
Please give your feedback on forum: [https://forum.vcmi.eu/t/experimental-snap-packages-for-linux/4300 Experimental Snap packages for Linux].
 +
-->
 +
== Flatpak (distribution-agnostic) ==
 +
Latest public release build can be installed via Flatpak.
 +
 
 +
Depending on your distribution, you may need to install flatpak itself.
 +
You can find guide for your distribution here: https://www.flatpak.org/setup/
 +
 
 +
Once you have flatpak, you can install VCMI package which can be found here: https://flathub.org/apps/details/eu.vcmi.VCMI
 +
 
 +
== Other distributions ==
 +
For other distributions, VCMI can be installed from 3rd-party repositories listed below. <br/>
 +
Note that these repositories are not supported by vcmi team and may not be up to date.
 +
* Archlinux [https://aur.archlinux.org/packages/vcmi/ vcmi] [https://aur.archlinux.org/packages/vcmi-git/ vcmi-git]
 +
* openSUSE [https://software.opensuse.org/download.html?project=games&package=vcmi 1 Click Install]
 +
If you are interested in providing builds for other distributions, please let us know.
 +
 
 +
== Compiling from source ==
 +
Please check following developer guide: [[How to build VCMI (Linux)]]
 +
 
 +
= Installing Heroes III data files =
 +
To install VCMI you will need Heroes III: Shadow of Death or Complete edition.
 +
 
 +
== Install data using vcmibuilder script (recommended for non-Flatpak installs) ==
 +
To install Heroes 3 data using automated script you need any of:
 +
* Offline Installer downloaded from gog.com (both .exe and .bin files are required)
 +
* Directory with preinstalled game
 +
* One or two CD's or CD images
 +
 
 +
Run the script using options appropriate to your input files:
 
<pre>
 
<pre>
sudo dpkg -i downloaded_package.deb
+
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd
sudo apt-get -f install
+
vcmibuilder --gog /path/to/gog.com/installer.exe
 +
vcmibuilder --data /path/to/h3/data
 
</pre>
 
</pre>
To start the game:
+
You should use only one of these commands.
 +
 
 +
On flatpak install, it's also possible to run the script, but any path seems to be interpreted from within the Flatpak sandbox:
 
<pre>
 
<pre>
vcmiclient
+
flatpak run --command=vcmibuilder eu.vcmi.VCMI --data /path/to/h3/data`
 +
</pre>
 +
 
 +
== Install data using gog.com offline installer ==
 +
 
 +
Download both files for the "offline backup game installers" and extract them using innoextract tool
 +
<pre>
 +
    innoextract --output-dir=~/Downloads/HoMM3 "setup_heroes_of_might_and_magic_3_complete_4.0_(28740).exe"
 
</pre>
 
</pre>
== Packages ==
+
(note that installer file name might be different)
* [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.87-1_oneiric_i386.deb Ubuntu 11.10 (oneiric) 32 bit]
 
* [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.87-1_oneiric_amd64.deb Ubuntu 11.10 (oneiric) 64 bit]
 
* [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.87-1_sid_i386.deb Debian sid 32 bit]
 
* [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.87-1_sid_amd64.deb Debian sid 64 bit]
 
  
== Other Debian-based distibutives ==
+
Once innoextract completes, start VCMI Launcher and choose to copy existing files. Select the ~/Downloads/HoMM3 directory. Once copy is complete, you can delete both offline installer files as well as ~/Downloads/HoMM3.
VCMI requires g++-4.5 and boost-1.46 which are unavailable on Debian stable and Ubuntu 10.10 or lower.
 
If you'll manage to install them you can compile VCMI from source code.
 
  
Another (and probably more safe) option is to create chroot enviroment ([https://help.ubuntu.com/community/DebootstrapChroot how-to]). This will allow to install package from another distributive.
+
== Install using existing Heroes III data ==
 +
 
 +
Copy "Data", "Maps" and "Mp3" from Heroes III to:
 +
<pre>$HOME/.local/share/vcmi/</pre>
 +
Or, in case of flatpak install to
 +
<pre>$HOME/.var/app/eu.vcmi.VCMI/data/vcmi/</pre>
 +
On some distributions $XDG_DATA_HOME could differ so instead you may need to use:
 +
<pre>$XDG_DATA_HOME/vcmi/</pre>
 +
 
 +
= Launching game =
 +
To start the game type in console:
 +
<pre>
 +
vcmilauncher
 +
</pre>
 +
Or, to start game directly avoiding Launcher:
 +
<pre>
 +
vcmiclient
 +
</pre>
 +
VCMI should be also available via desktop environment menu or launcher (Games/Strategy/VCMI)
  
== Other Linux distibutives ==
+
= Reporting bugs =
Currently VCMI supports generation of .deb packages only. Patches to add support of other package formats are welcomed.
+
Please report any issues with packages according to
= Compiling from source =
+
[http://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines Bug reporting guidelines]
For compiling from source see [https://vcmi.svn.sourceforge.net/svnroot/vcmi/trunk/README.linux README.linux] file.
 
You can get packaged source [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.87-1.tar.gz here]
 
= Bugs =
 
Report any issues with packages on our [http://bugs.vcmi.eu bugtracker] or post a message on [http://forum.vcmi.eu/index.php VCMI forums]
 

Latest revision as of 11:31, 4 August 2023

VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.

Binaries installation

Ubuntu

Latest stable build from PPA (recommended)

Up-to-date releases can be found in our PPA here: https://launchpad.net/~vcmi/+archive/ubuntu/ppa

To install VCMI from PPA use:

sudo apt-add-repository ppa:vcmi/ppa
sudo apt update
sudo apt install vcmi

Unstable testing build from PPA

We also provide latest, unstable builds mostly suitable for testing here: https://launchpad.net/~vcmi/+archive/ubuntu/vcmi-latest

In order to install from this PPA use:

sudo add-apt-repository ppa:vcmi/vcmi-latest
sudo apt update
sudo apt install vcmi

From Ubuntu repository

VCMI stable builds available in "multiverse" repository. Learn how to enable it in Ubuntu wiki.

Once enabled, you can install VCMI using Ubuntu Store or in terminal using following commands:

sudo apt update
sudo apt install vcmi

Note that version available in Ubuntu is outdated. Install via PPA is preferred.

Debian

Stable VCMI version is available in "contrib" repository. Learn how to enable it in Debian wiki.

To install VCMI from repository:

sudo apt-get update
sudo apt-get install vcmi

Flatpak (distribution-agnostic)

Latest public release build can be installed via Flatpak.

Depending on your distribution, you may need to install flatpak itself. You can find guide for your distribution here: https://www.flatpak.org/setup/

Once you have flatpak, you can install VCMI package which can be found here: https://flathub.org/apps/details/eu.vcmi.VCMI

Other distributions

For other distributions, VCMI can be installed from 3rd-party repositories listed below.
Note that these repositories are not supported by vcmi team and may not be up to date.

If you are interested in providing builds for other distributions, please let us know.

Compiling from source

Please check following developer guide: How to build VCMI (Linux)

Installing Heroes III data files

To install VCMI you will need Heroes III: Shadow of Death or Complete edition.

Install data using vcmibuilder script (recommended for non-Flatpak installs)

To install Heroes 3 data using automated script you need any of:

  • Offline Installer downloaded from gog.com (both .exe and .bin files are required)
  • Directory with preinstalled game
  • One or two CD's or CD images

Run the script using options appropriate to your input files:

vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd
vcmibuilder --gog /path/to/gog.com/installer.exe
vcmibuilder --data /path/to/h3/data

You should use only one of these commands.

On flatpak install, it's also possible to run the script, but any path seems to be interpreted from within the Flatpak sandbox:

flatpak run --command=vcmibuilder eu.vcmi.VCMI --data /path/to/h3/data`

Install data using gog.com offline installer

Download both files for the "offline backup game installers" and extract them using innoextract tool

    innoextract --output-dir=~/Downloads/HoMM3 "setup_heroes_of_might_and_magic_3_complete_4.0_(28740).exe"

(note that installer file name might be different)

Once innoextract completes, start VCMI Launcher and choose to copy existing files. Select the ~/Downloads/HoMM3 directory. Once copy is complete, you can delete both offline installer files as well as ~/Downloads/HoMM3.

Install using existing Heroes III data

Copy "Data", "Maps" and "Mp3" from Heroes III to:

$HOME/.local/share/vcmi/

Or, in case of flatpak install to

$HOME/.var/app/eu.vcmi.VCMI/data/vcmi/

On some distributions $XDG_DATA_HOME could differ so instead you may need to use:

$XDG_DATA_HOME/vcmi/

Launching game

To start the game type in console:

vcmilauncher

Or, to start game directly avoiding Launcher:

vcmiclient

VCMI should be also available via desktop environment menu or launcher (Games/Strategy/VCMI)

Reporting bugs

Please report any issues with packages according to Bug reporting guidelines