Installation on Linux

From VCMI Project Wiki
Revision as of 23:32, 9 December 2022 by Ivan (talk | contribs) (Other distributions)
Jump to: navigation, search

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

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 following commands:

sudo apt update
sudo apt install vcmi

Latest stable build from PPA

More 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

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.

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/.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