Difference between revisions of "Installation on Linux"

From VCMI Project Wiki
Jump to: navigation, search
(→‎Debian)
(→‎Ubuntu)
(39 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
= Binaries installation =
 
= Binaries installation =
 
== Ubuntu ==
 
== Ubuntu ==
−
VCMI can be installed from PPA:
+
'''Latest stable build from PPA (recommended)'''
  
−
* stable version (recommended): https://launchpad.net/~saven-ivan/+archive/vcmi
+
Up-to-date releases can be found in our PPA here: https://launchpad.net/~vcmi/+archive/ubuntu/ppa
−
* daily builds (for testing only): https://launchpad.net/~vcmi/+archive/ppa
 
  
−
To use it type in Terminal:
+
To install VCMI from PPA use:
 
<pre>
 
<pre>
−
sudo apt-add-repository ppa:saven-ivan/vcmi
+
sudo apt-add-repository ppa:vcmi/ppa
−
sudo apt-get update
+
sudo apt update
−
sudo apt-get install vcmi
+
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>
 
</pre>
  
−
== Debian ==
+
'''From Ubuntu repository'''
−
Download and install package for your distribution. Install can be done using any GUI managers or using command line:
+
 
 +
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>
 
<pre>
−
sudo dpkg -i downloaded_package.deb
+
sudo apt update
−
sudo apt-get -f install
+
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 second one.
 
  
−
{|
+
Note that version available in Ubuntu is outdated. Install via PPA is preferred.
−
|'''Debian Wheezy'''
 
−
|[http://download.vcmi.eu/vcmi_0.96_i386.deb 32 bit]
 
−
|[http://download.vcmi.eu/vcmi_0.96_amd64.deb 64 bit]
 
−
|}
 
  
−
== Fedora ==
+
== Debian ==
−
'''Fedora packages are no longer supported officially.''' The last release is VCMI 0.95 for Fedora 20. The .SPEC file for generating the .RPM package resides in the VCMI repository on Github. If you are interested in providing RPM builds, please let us know.
 
  
−
Download and install package for your distribution. There are two ways to install package along with all dependencies:  
+
Stable VCMI version is available in "contrib" repository. Learn how to enable it in [https://wiki.debian.org/SourcesList Debian wiki].
  
−
Option A) Double-click the package. A package management window should appear with instructions to guide you through the process.
+
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:
  
−
Option B) Open a terminal window, and type
+
* 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>
 +
$HOME/snap/vcmi/current/.local/share/vcmi/
 +
</pre>
 +
* To update to latest version:
 
<pre>
 
<pre>
−
sudo rpm -i package_location_and_name(e.g. vcmi-0.9.5-1.fc20.x86_64.rpm)
+
sudo snap refresh vcmi
 
</pre>
 
</pre>
  
−
{|
+
'''Warning:''' Snap builds are currently in experimental state.
−
|'''Fedora 20 (VCMI 0.95)'''
+
 
−
|[https://www.dropbox.com/s/ieonm9ot3qstylm/vcmi-0.9.5-1.fc20.i686.rpm 32 bit]
+
Please give your feedback on forum: [https://forum.vcmi.eu/t/experimental-snap-packages-for-linux/4300 Experimental Snap packages for Linux].
−
|[https://www.dropbox.com/s/vd6g0fp68b5vw53/vcmi-0.9.5-1.fc20.x86_64.rpm 64 bit]
+
-->
−
|}
+
== 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 ==
 
== Other distributions ==
−
For other distributions, VCMI can be installed from 3rd-party repositories listed below.
+
For other distributions, VCMI can be installed from 3rd-party repositories listed below. <br/>
−
* Gentoo https://github.com/qdii/qdiilay/tree/master/games-strategy/vcmi
+
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]
 
* 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 ==
 
== Compiling from source ==
−
* [http://download.vcmi.eu/vcmi-0.96.tar.gz Packaged source for latest version]
+
Please check following developer guide: [[How to build VCMI (Linux)]]
−
* [https://github.com/vcmi/vcmi/releases Alternative download links on github]
 
−
* [https://github.com/vcmi/vcmi/blob/develop/README.linux Readme] (available as README.linux in source package)
 
  
 
= Installing Heroes III data files =
 
= Installing Heroes III data files =
−
To install VCMI you will need:
+
To install VCMI you will need Heroes III: Shadow of Death or Complete edition.
−
* Heroes III: Shadow of Death or Complete edition
+
 
−
* Unnoficial WoG addon: http://download.vcmi.eu/WoG/wog.zip
+
== Install data using vcmibuilder script (recommended for non-Flatpak installs) ==
−
* VCMI data files: http://download.vcmi.eu/core.zip
 
−
== Automated install ==
 
 
To install Heroes 3 data using automated script you need any of:
 
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
 
* One or two CD's or CD images
−
* gog.com installer
 
−
* Directory with installed game
 
  
 
Run the script using options appropriate to your input files:
 
Run the script using options appropriate to your input files:
 
<pre>
 
<pre>
−
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd --download
+
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd
−
vcmibuilder --gog /path/to/gog.com/installer --download
+
vcmibuilder --gog /path/to/gog.com/installer.exe
−
vcmibuilder --data /path/to/h3/data --download
+
vcmibuilder --data /path/to/h3/data
 
</pre>
 
</pre>
 
You should use only one of these commands.
 
You should use only one of these commands.
  
−
=== Offline install ===
+
On flatpak install, it's also possible to run the script, but any path seems to be interpreted from within the Flatpak sandbox:
−
Normally vcmibuilder script will autodownload WoG and VCMI data packages. For offline install you need to download this packages manually and replace download switch with this:
 
 
<pre>
 
<pre>
−
vcmibuilder <h3 data commands> --wog /path/to/wog/archive --vcmi /path/to/vcmi/package
+
flatpak run --command=vcmibuilder eu.vcmi.VCMI --data /path/to/h3/data`
 
</pre>
 
</pre>
−
Where '''h3 data commands''' stands for described earlier option(s) needed to install H3 data (path to data, Install CD or gog.com installer)
 
  
−
=== Fedora music support ===
+
== Install data using gog.com offline installer ==
−
To have Music support on Fedora it is required to perform a additional step. Fedora doesn't provide Mp3 playback support natively due to patents applied on the Mp3 technique. The SDL_mixer package from the official Fedora repo is compiled without Mp3 support.
 
  
−
To make music work it must be converted into ogg format. This can be done either manually or using vcmibuilder:
+
Download both files for the "offline backup game installers" and extract them using innoextract tool
 
<pre>
 
<pre>
−
vcmibuilder --convertMP3
+
    innoextract --output-dir=~/Downloads/HoMM3 "setup_heroes_of_might_and_magic_3_complete_4.0_(28740).exe"
 
</pre>
 
</pre>
−
This command can be run separately after install or as additional switch during initial vcmibuilder launch
+
(note that installer file name might be different)
  
−
== Manual install ==
+
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 Heroes III
+
== Install using existing Heroes III data ==
−
* Extract WoG addon http://download.vcmi.eu/WoG/wog.zip
 
−
* Extract VCMI data files: http://download.vcmi.eu/core.zip
 
  
−
Launch vcmiclient to determine data directory (output may differ)
+
Copy "Data", "Maps" and "Mp3" from Heroes III to:
−
<pre>
+
<pre>$HOME/.local/share/vcmi/</pre>
−
$vcmiclient -v
+
Or, in case of flatpak install to
−
Starting...
+
<pre>$HOME/.var/app/eu.vcmi.VCMI/data/vcmi/</pre>
−
VCMI 0.91
+
On some distributions $XDG_DATA_HOME could differ so instead you may need to use:
−
  data directory:    /usr/share/vcmi
+
<pre>$XDG_DATA_HOME/vcmi/</pre>
−
  library directory: /usr/lib/vcmi
 
−
  binary directory:  /usr/games
 
−
</pre>
 
−
Copy your data to data directory. This should result in directory structure similar to this:
 
−
<pre>
 
−
/usr/share/vcmi/config/
 
−
/usr/share/vcmi/Data/
 
−
/usr/share/vcmi/Maps/
 
−
/usr/share/vcmi/Mods/WoG/
 
−
/usr/share/vcmi/Mods/vcmi/
 
−
/usr/share/vcmi/Mp3/
 
−
</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>
 
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
 

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"