Difference between revisions of "Installation on Linux"

From VCMI Project Wiki
Jump to: navigation, search
(switched links to vcmi.eu)
(→‎Ubuntu)
 
(87 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.
 
VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.
−
All links are for VCMI 0.89
 
 
= Binaries installation =
 
= Binaries installation =
−
== Debian-based distibutives ==
+
== Ubuntu ==
−
Download and install package for your distributive. To install package along with all dependencies:
+
'''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>
 
<pre>
−
sudo dpkg -i downloaded_package.deb
+
sudo apt-add-repository ppa:vcmi/ppa
−
sudo apt-get -f install
+
sudo apt update
 +
sudo apt install vcmi
 
</pre>
 
</pre>
−
Note: First command most probably will result in errors - this is normal behavior, all of them should be fixed by apt-get
 
  
−
=== Packages ===
+
'''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'''
−
|'''Ubuntu 12.04 precise'''
 
−
|[http://download.vcmi.eu/vcmi_0.89_precise_i386.deb 32 bit]
 
−
|[http://download.vcmi.eu/vcmi_0.89_precise_amd64.deb 64 bit]
 
−
|-
 
−
|'''Ubuntu 11.10 oneiric'''
 
−
|[http://download.vcmi.eu/vcmi_0.89_oneiric_i386.deb 32 bit]
 
−
|[http://download.vcmi.eu/vcmi_0.89_oneiric_amd64.deb 64 bit]
 
−
|-
 
−
|'''Debian Sid'''
 
−
|[http://download.vcmi.eu/vcmi_0.89_sid_i386.deb 32 bit]
 
−
|[http://download.vcmi.eu/vcmi_0.89_sid_amd64.deb 64 bit]
 
−
|-
 
−
|'''Debian Wheezy'''
 
−
|[http://download.vcmi.eu/vcmi_0.89_wheezy_i386.deb 32 bit]
 
−
|[http://download.vcmi.eu/vcmi_0.89_wheezy_amd64.deb 64 bit]
 
−
|}
 
  
−
=== Other Debian-based distibutives ===
+
VCMI stable builds available in "multiverse" repository. Learn how to enable it in [https://help.ubuntu.com/community/Repositories/Ubuntu Ubuntu wiki].
−
VCMI requires g++-4.5 and boost-1.46 which are unavailable on Debian Squeeze and Ubuntu 11.04 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.
+
Once enabled, you can install VCMI using Ubuntu Store or in terminal using following commands:
 +
<pre>
 +
sudo apt update
 +
sudo apt install vcmi
 +
</pre>
  
−
== Other Linux distibutives ==
+
Note that version available in Ubuntu is outdated. Install via PPA is preferred.
−
Currently VCMI supports generation of .deb packages only. Patches to add support of any other package formats are welcomed.
 
−
== Compiling from source ==
 
−
For compiling from source see [https://vcmi.svn.sourceforge.net/svnroot/vcmi/trunk/README.linux README.linux] file.
 
−
You can get packaged source for current version [http://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.89.tar.gz here]
 
  
−
= Preparing data =
+
== Debian ==
−
The main idea of this step is to prepare all the data (sprites, sound files, maps, etc.) that VCMI needs to run and to put them into VCMI's "'''data directory'''" which is where VCMI expects to find them. The '''VCMI data package''' provides some of these data files. The rest come from the original H3 game and from the WoG expansion pack. All 3 need to be merged and placed into VCMI's data directory and this step explains how to do this.
 
  
−
Install original game and WoG addon. This can be done via Wine or from Windows.
+
Stable VCMI version is available in "contrib" repository. Learn how to enable it in [https://wiki.debian.org/SourcesList Debian wiki].
  
−
Extract [http://download.vcmi.eu/vcmi-data_0.89.tar.gz VCMI data package] into the H3+WoG installation directory. If you used Wine and '''accepted the installer defaults''' this should be:  
+
To install VCMI from repository:
 
<pre>
 
<pre>
−
~/.wine/drive_c/Program\ Files/3DO/Heroes3/
+
sudo apt-get update
 +
sudo apt-get install vcmi
 
</pre>
 
</pre>
 +
<!-- DISABLED - SNAP PACKAGE IS OUTDATED
 +
== Snappy ==
 +
It's possible to install daily VCMI builds as distribution-agnostic Snap package:
  
−
After you have done the above you should have all 3 sources of data properly merged and ready to be copied into VCMI's data directory.
+
* Visit [https://snapcraft.io/ snapcraft.io] to learn how to get Snappy on your distribution.
−
 
+
* Once it's running install latest VCMI build with:
−
Launch vcmiclient to determine data directory:
+
<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>
 +
$HOME/snap/vcmi/current/.local/share/vcmi/
 +
</pre>
 +
* To update to latest version:
 
<pre>
 
<pre>
−
vcmiclient -v
+
sudo snap refresh vcmi
 
</pre>
 
</pre>
  
−
The above command will display something similar to this:
+
'''Warning:''' Snap builds are currently in experimental state.
 +
 
 +
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>
−
Starting...
+
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd
−
VCMI 0.89
+
vcmibuilder --gog /path/to/gog.com/installer.exe
−
  data directory:    /usr/share/vcmi
+
vcmibuilder --data /path/to/h3/data
−
  library directory: /usr/lib/vcmi
 
−
  binary directory:  /usr/bin/vcmi
 
−
    ...
 
 
</pre>
 
</pre>
 +
You should use only one of these commands.
  
−
Copy installed game to the "data directory". This should give you directory structure similar to this:
+
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>
−
/usr/share/vcmi/config/
+
flatpak run --command=vcmibuilder eu.vcmi.VCMI --data /path/to/h3/data`
−
/usr/share/vcmi/Data/
 
−
/usr/share/vcmi/Maps/
 
−
/usr/share/vcmi/Mp3/
 
−
/usr/share/vcmi/Sprites/
 
 
</pre>
 
</pre>
−
Note: Depending on whether you are installing one of the binary packages or compiling from source and how you configured the data directory prefix (--datadir) of your source package it may be e.g. /usr/local/share/vcmi or /opt/games/vcmi or something else. In any case it must end in "vcmi" and contain the sub-directories listed above.
 
  
−
Note: In some Heroes 3 editions these directories may have different case (e.g. MP3 vs Mp3). In this case you'll have to rename them to match required directory structure.
+
== Install data using gog.com offline installer ==
  
−
If you also have original Linux version of Heroes 3 by LOKI, you can also install the videos:
+
Download both files for the "offline backup game installers" and extract them using innoextract tool
 
<pre>
 
<pre>
−
cp -a /PATH_TO_CDROM/data/video /usr/share/vcmi/Data
+
    innoextract --output-dir=~/Downloads/HoMM3 "setup_heroes_of_might_and_magic_3_complete_4.0_(28740).exe"
 
</pre>
 
</pre>
 +
(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:
 +
<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 =
 
= Launching game =
 
To start the game type in console:
 
To start the game type in console:
 +
<pre>
 +
vcmilauncher
 +
</pre>
 +
Or, to start game directly avoiding Launcher:
 
<pre>
 
<pre>
 
vcmiclient
 
vcmiclient
 
</pre>
 
</pre>
−
Starting from 0.89 VCMI should be also available via desktop environment menu or launcher (Games/Strategy/VCMI)
+
VCMI should be also available via desktop environment menu or launcher (Games/Strategy/VCMI)
 +
 
 
= Reporting bugs =
 
= Reporting 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]
+
Please report any issues with packages according to
−
In report please post:
+
[http://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines Bug reporting guidelines]
−
* used distributive, version and architecture (for example "Ubuntu 11.10 32 bit"). For distributives that use rolling releases please post versions of all used libraries (boost, ffmpeg, SDL)
 
−
* console log as well as log files from ~/.vcmi
 
−
* steps to reproduce bug
 

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

Retrieved from "https://wiki.vcmi.eu/index.php?title=Installation_on_Linux&oldid=3609"