Difference between revisions of "Installation on Linux"

From VCMI Project Wiki
Jump to: navigation, search
(Debian)
(added openSUSE)
(19 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
= Binaries installation =
 
= Binaries installation =
 
== Ubuntu ==
 
== Ubuntu ==
VCMI can be installed from PPA:
 
  
* stable version (recommended): https://launchpad.net/~saven-ivan/+archive/vcmi
+
VCMI stable builds available in "multiverse" repository. Learn how to enable it in [https://help.ubuntu.com/community/Repositories/Ubuntu Ubuntu wiki].
* daily builds (for testing only): https://launchpad.net/~vcmi/+archive/ppa
 
  
To use it type in Terminal:
+
VCMI daily builds can be installed from PPA:
 +
* For testing only: https://launchpad.net/~vcmi/+archive/ppa
 +
 
 +
To add PPA type in Terminal:
 +
<pre>
 +
sudo apt-add-repository ppa:vcmi/ppa
 +
</pre>
 +
 
 +
To install VCMI from repository:
 
<pre>
 
<pre>
sudo apt-add-repository ppa:saven-ivan/vcmi
 
 
sudo apt-get update
 
sudo apt-get update
 
sudo apt-get install vcmi
 
sudo apt-get install vcmi
Line 15: Line 20:
  
 
== Debian ==
 
== Debian ==
Download and install package for your distribution. Install can be done using any GUI managers or using command line:
+
 
 +
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>
 
<pre>
sudo dpkg -i downloaded_package.deb
+
sudo apt-get update
sudo apt-get -f install
+
sudo apt-get 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.
 
  
{|
+
== Snappy ==
|'''Debian Wheezy (VCMI 0.96)'''
+
It's possible to install daily VCMI builds as distribution-agnostic Snap package:
|[http://download.vcmi.eu/vcmi_0.96_i386.deb 32 bit]
 
|[http://download.vcmi.eu/vcmi_0.96_amd64.deb 64 bit]
 
|}
 
  
== Fedora ==
+
* Visit [https://snapcraft.io/ snapcraft.io] to learn how to get Snappy on your distribution.
'''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.
+
* Once it's running install latest VCMI build with:
 
+
<pre>
Download and install package for your distribution. There are two ways to install package along with all dependencies:  
+
sudo snap install --edge vcmi
 
+
</pre>
Option A) Double-click the package. A package management window should appear with instructions to guide you through the process.
+
* After you can run VCMI with following commands:
 
+
<pre>
Option B) Open a terminal window, and type
+
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]
 
|}
 
  
 
== Other distributions ==
 
== Other distributions ==
Line 50: Line 60:
 
* Gentoo https://github.com/qdii/qdiilay/tree/master/games-strategy/vcmi
 
* Gentoo https://github.com/qdii/qdiilay/tree/master/games-strategy/vcmi
 
* 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/releases/097/vcmi-0.97.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)
 
 
 
Be careful about proper installation of VCMI. The game requires some files from its source distribution to be placed in data path, so you must use make install to install the game properly. Otherwise, the game won't be able to find resource files.
 
If you don't want to pollute your filesystem with game files, use the following way of installing the game:
 
 
 
<pre>
 
# cmake -DCMAKE_INSTALL_PREFIX=absolute_path_to_binaries ../vcmi
 
# make && make install
 
# cd absolute_path_to_binaries
 
# ./bin/vcmiclient
 
</pre>
 
  
 
= 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
 
* VCMI data files: http://download.vcmi.eu/core.zip
 
 
== Automated install ==
 
== 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:
Line 85: Line 82:
 
You should use only one of these commands.
 
You should use only one of these commands.
  
=== Fedora music support ===
+
=== Music on distributions without Mp3 support ===
 
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 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.
  
Line 96: Line 93:
 
== Manual install ==
 
== Manual install ==
  
* Install Heroes III
+
* Install Heroes III in Wine or manually unpack GOG installer.
  
* Launch vcmiclient to determine data directory (output may differ)
+
* Copy "Data", "Maps" and "Mp3" from Heroes III to:
<pre>
+
<pre>/home/$USER/.local/share/vcmi/</pre>
$vcmiclient -v
+
On some distributions $XDG_DATA_HOME could differ so instead you may need to use:
Starting...
+
<pre>$XDG_DATA_HOME/vcmi/</pre>
VCMI 0.91
 
  data directory:    /usr/share/vcmi
 
  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 =
Line 129: Line 112:
  
 
= 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 proceed according to  
 
 
[http://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines Bug reporting guidelines]
 
[http://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines Bug reporting guidelines]

Revision as of 20:27, 2 January 2018

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

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

VCMI daily builds can be installed from PPA:

To add PPA type in Terminal:

sudo apt-add-repository ppa:vcmi/ppa

To install VCMI from repository:

sudo apt-get update
sudo apt-get install vcmi

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

Snappy

It's possible to install daily VCMI builds as distribution-agnostic Snap package:

  • Visit snapcraft.io to learn how to get Snappy on your distribution.
  • Once it's running install latest VCMI build with:
sudo snap install --edge vcmi
  • After you can run VCMI with following commands:
snap run vcmi.vcmilauncher
snap run vcmi.vcmiclient
snap run vcmi.vcmiserver
  • Keep in mind that instead of $HOME/.local/share/vcmi/ you must copy Heroes 3 assets into:
$HOME/snap/vcmi/current/.local/share/vcmi/
  • To update to latest version:
sudo snap refresh vcmi

Warning: Snap builds are currently in experimental state.

Please give your feedback on forum: Experimental Snap packages for Linux.

Other distributions

For other distributions, VCMI can be installed from 3rd-party repositories listed below.

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.

Automated install

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

  • 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:

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

You should use only one of these commands.

Music on distributions without Mp3 support

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:

vcmibuilder --convertMP3

This command can be run separately after install or as additional switch during initial vcmibuilder launch

Manual install

  • Install Heroes III in Wine or manually unpack GOG installer.
  • Copy "Data", "Maps" and "Mp3" from Heroes III to:
/home/$USER/.local/share/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