Difference between revisions of "Installation on Linux"

From VCMI Project Wiki
Jump to: navigation, search
(Running the script)
(Update to v 0.91, some cleanup)
Line 1: Line 1:
 
VCMI requires data from original Heroes 3: Shadow of Death or Complete editions and from the WoG expansion pack. Data from native Linux version made by LOKI will not work.
 
VCMI requires data from original Heroes 3: Shadow of Death or Complete editions and from the WoG expansion pack. Data from native Linux version made by LOKI will not work.
All links are for VCMI 0.9
 
 
= Binaries installation =
 
= Binaries installation =
 
== Debian-based distributions ==
 
== Debian-based distributions ==
Download and install package for your distribution. To install package along with all dependencies:
+
Download and install package for your distribution. Install can be done using any GUI managers or using command line:
 
<pre>
 
<pre>
 
sudo dpkg -i downloaded_package.deb
 
sudo dpkg -i downloaded_package.deb
 
sudo apt-get -f install
 
sudo apt-get -f install
 
</pre>
 
</pre>
Note: First command most probably will result in errors - this is normal behavior, all of them should be fixed by apt-get
+
Note: First command most probably will result in errors - this is normal behavior, all of them should be fixed by second one.
 
 
 
=== Packages ===
 
=== Packages ===
  
 
{|
 
{|
 
|'''Ubuntu 12.10 quantal'''
 
|'''Ubuntu 12.10 quantal'''
|[http://download.vcmi.eu/vcmi_0.90~quantal1_i386.deb 32 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~quantal1_i386.deb 32 bit]
|[http://download.vcmi.eu/vcmi_0.90~quantal1_amd64.deb 64 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~quantal1_amd64.deb 64 bit]
 
|-
 
|-
 
|'''Ubuntu 12.04 precise'''
 
|'''Ubuntu 12.04 precise'''
|[http://download.vcmi.eu/vcmi_0.90~precise1_i386.deb 32 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~precise1_i386.deb 32 bit]
|[http://download.vcmi.eu/vcmi_0.90~precise1_amd64.deb 64 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~precise1_amd64.deb 64 bit]
 
|-
 
|-
|'''Ubuntu 11.10 oneiric'''
+
|'''Debian Wheezy'''
|[http://download.vcmi.eu/vcmi_0.90~oneiric1_i386.deb 32 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~wheezy1_i386.deb 32 bit]
|[http://download.vcmi.eu/vcmi_0.90~oneiric1_amd64.deb 64 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~wheezy1_amd64.deb 64 bit]
 
|-
 
|-
 
|'''Debian Sid'''
 
|'''Debian Sid'''
|[http://download.vcmi.eu/vcmi_0.90~sid1_i386.deb 32 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~sid1_i386.deb 32 bit]
|[http://download.vcmi.eu/vcmi_0.90~sid1_amd64.deb 64 bit]
+
|[https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.91~sid1_amd64.deb 64 bit]
|-
 
|'''Debian Wheezy'''
 
|[http://download.vcmi.eu/vcmi_0.90~wheezy1_i386.deb 32 bit]
 
|[http://download.vcmi.eu/vcmi_0.90~wheezy1_amd64.deb 64 bit]
 
 
|}
 
|}
  
 
=== Other Debian-based distributions ===
 
=== Other Debian-based distributions ===
 
VCMI requires g++-4.5 and boost-1.46 which are unavailable on Debian Squeeze and Ubuntu 11.04 or lower.
 
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.
+
In order for VCMI to work on this system you'll need to install them first.
 
 
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 distribution.
 
 
 
 
== RPM-based distributions ==
 
== RPM-based distributions ==
 
Download and install package for your distribution. There are two ways to install package along with all dependencies:  
 
Download and install package for your distribution. There are two ways to install package along with all dependencies:  
Line 58: Line 49:
  
 
== Compiling from source ==
 
== Compiling from source ==
For compiling from source see [https://vcmi.svn.sourceforge.net/svnroot/vcmi/trunk/README.linux README.linux] file.
+
* [https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi-0.91.tar.gz Packaged source]
You can get packaged source for current version [https://dl.dropbox.com/u/22372764/vcmi/packages/vcmi_0.90.tar.gz here]
+
* [https://vcmi.svn.sourceforge.net/svnroot/vcmi/trunk/README.linux Readme] (available in README.linux file in source package)
 
 
= Preparing data =
 
== Using vcmibuilder script ==
 
''' This method is not available in vcmi 0.90 '''
 
=== Preparation ===
 
  
To install Heroes 3 data using vcmibuilder script you need original game data which can be:
+
= Installing Heroes III data files =
* As one or two CD's or CD images
+
To install VCMI you will need:
* In form of gog.com installer
+
* Heroes III: Shadow of Death or Complete edition
* Directory with already installed game
+
* Unnoficial WoG addon: http://download.vcmi.eu/WoG/wog.zip
Additionally you will need WoG and VCMI data files. They can be automatically downloaded by script or downloaded manually using these links:
+
* VCMI data files: https://dl.dropbox.com/u/22372764/vcmi/mods/core.zip
* WoG package: http://download.vcmi.eu/WoG/wog.zip
+
== Automated install ==
* VCMI data files: http://download.vcmi.eu/core.zip
+
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
  
=== Running the script ===
 
 
Create temporary directory that will be used by script and go into it:
 
Create temporary directory that will be used by script and go into it:
 
<pre>
 
<pre>
Line 80: Line 68:
 
cd temp
 
cd temp
 
</pre>
 
</pre>
Run the script specifying location of data files. Run "vcmibuilder --help" to see all possible options or use one of [[#Examples|examples]] in section below.
+
Run the script using options appropriate to your input files:
 
 
Launch vcmiclient to determine data directory:
 
 
<pre>
 
<pre>
vcmiclient -v
+
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd --download
 +
vcmibuilder --gog /path/to/gog.com/installer --download
 +
vcmibuilder --data /path/to/h3/data --download
 
</pre>
 
</pre>
This command will display something similar to this:
+
You should use only one of these commands.
 +
 
 +
Launch vcmiclient to determine data directory (output may differ)
 
<pre>
 
<pre>
 +
$vcmiclient -v
 
Starting...  
 
Starting...  
VCMI 0.90
+
VCMI 0.91
 
   data directory:    /usr/share/vcmi
 
   data directory:    /usr/share/vcmi
 
   library directory: /usr/lib/vcmi
 
   library directory: /usr/lib/vcmi
Line 100: Line 91:
 
</pre>
 
</pre>
  
=== Examples ===
+
=== Offline install ===
1) Using gog.com installer and auto-downloading additional packages
+
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 --gog /path/to/gog.com/executable --download
+
vcmibuilder <h3 data commands> --wog /path/to/wog/archive --vcmi /path/to/vcmi/package
 
</pre>
 
</pre>
2) Using original CD's and manually downloaded data packages
 
  
Note: if your installation comes with single CD you still need to specify both "cd1" and "cd2" keys, pointing at the same location
+
=== Fedora music support ===
<pre>
+
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. Luckily this isn't a huge problem due to the filesystem API of VCMI. If you place ogg files in the Mp3 folder it'll use those files. So all you have to do is to convert the original Mp3 to OGG by yourself. Then copy them to the /Mp3 folder and remove the old .mp3 files with e.g. rm -rf *.mp3. You may use those tools for converting MP3 to OGG e.g.: Dirogg Bash Script http://freecode.com/projects/dirogg or the graphical program SoundConverter(sudo yum install soundconverter).
vcmibuilder --cd1 /first/cd --cd2 /second/cd --wog /wog/archive --vcmi /vcmi/arhive
 
</pre>
 
3) Using preinstalled Heroes 3 and manually downloaded WoG package
 
<pre>
 
vcmibuilder --data /path/to/heroes3/data --wog /path/to/wog/archive --download
 
</pre>
 
 
 
== Manual installation ==
 
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.
 
To install WoG you can extract [https://dl.dropbox.com/u/22372764/vcmi/mods/wog.zip this archive] into Heroes 3 install directory. VCMI is also compatible with original WoG installer as well as WoG bundled with Era.
 
 
 
Extract [http://download.vcmi.eu/core.zip VCMI data package] into the H3 installation directory. If you used Wine and '''accepted the installer defaults''' this should be:
 
<pre>
 
~/.wine/drive_c/Program\ Files/3DO/Heroes3/
 
</pre>
 
  
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.
+
== Manual install ==
  
Launch vcmiclient to determine data directory:
+
* Install Heroes III
<pre>
+
* Extract WoG addon http://download.vcmi.eu/WoG/wog.zip
vcmiclient -v
+
* Extract VCMI data files: https://dl.dropbox.com/u/22372764/vcmi/mods/core.zip
</pre>
 
  
The above command will display something similar to this:
+
Launch vcmiclient to determine data directory (output may differ)
 
<pre>
 
<pre>
 +
$vcmiclient -v
 
Starting...  
 
Starting...  
VCMI 0.90
+
VCMI 0.91
 
   data directory:    /usr/share/vcmi
 
   data directory:    /usr/share/vcmi
 
   library directory: /usr/lib/vcmi
 
   library directory: /usr/lib/vcmi
 
   binary directory:  /usr/bin/vcmi
 
   binary directory:  /usr/bin/vcmi
    ...
 
 
</pre>
 
</pre>
 
+
Copy your data to data directory. This should result in directory structure similar to this:
Copy installed game to the "data directory". This should give you directory structure similar to this:
 
 
<pre>
 
<pre>
 
/usr/share/vcmi/config/
 
/usr/share/vcmi/config/
 
/usr/share/vcmi/Data/
 
/usr/share/vcmi/Data/
 
/usr/share/vcmi/Maps/
 
/usr/share/vcmi/Maps/
/usr/share/vcmi/Mods/
+
/usr/share/vcmi/Mods/WoG/
 +
/usr/share/vcmi/Mods/vcmi/
 
/usr/share/vcmi/Mp3/
 
/usr/share/vcmi/Mp3/
 
</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.
 
 
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. Luckily this isn't a huge problem due to the filesystem API of VCMI. If you place ogg files in the Mp3 folder it'll use those files. So all you have to do is to convert the original Mp3 to OGG by yourself. Then copy them to the /Mp3 folder and remove the old .mp3 files with e.g. rm -rf *.mp3. You may use those tools for converting MP3 to OGG e.g.: Dirogg Bash Script http://freecode.com/projects/dirogg or the graphical program SoundConverter(sudo yum install soundconverter).
 
  
 
= Launching game =
 
= Launching game =

Revision as of 12:32, 1 February 2013

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

Binaries installation

Debian-based distributions

Download and install package for your distribution. Install can be done using any GUI managers or using command line:

sudo dpkg -i downloaded_package.deb
sudo apt-get -f install

Note: First command most probably will result in errors - this is normal behavior, all of them should be fixed by second one.

Packages

Ubuntu 12.10 quantal 32 bit 64 bit
Ubuntu 12.04 precise 32 bit 64 bit
Debian Wheezy 32 bit 64 bit
Debian Sid 32 bit 64 bit

Other Debian-based distributions

VCMI requires g++-4.5 and boost-1.46 which are unavailable on Debian Squeeze and Ubuntu 11.04 or lower. In order for VCMI to work on this system you'll need to install them first.

RPM-based distributions

Download and install package for your distribution. There are two ways to install package along with all dependencies:

Option A) Double-click the package. A package management window should appear with instructions to guide you through the process.

Option B) Open a terminal window, and type

sudo rpm -i package_location_and_name(e.g. vcmi-0.89-1.fc16.x86_64.rpm)

Packages

Fedora 17 32 bit 64 bit

Compiling from source

Installing Heroes III data files

To install VCMI you will need:

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

Create temporary directory that will be used by script and go into it:

mkdir temp
cd temp

Run the script using options appropriate to your input files:

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

You should use only one of these commands.

Launch vcmiclient to determine data directory (output may differ)

$vcmiclient -v
Starting... 
VCMI 0.91
  data directory:    /usr/share/vcmi
  library directory: /usr/lib/vcmi
  binary directory:  /usr/bin/vcmi

Copy resulting files into your vcmi data directory:

cp -RTu vcmi /path/to/vcmi/data/directory

Offline install

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:

vcmibuilder <h3 data commands> --wog /path/to/wog/archive --vcmi /path/to/vcmi/package

Fedora music 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. Luckily this isn't a huge problem due to the filesystem API of VCMI. If you place ogg files in the Mp3 folder it'll use those files. So all you have to do is to convert the original Mp3 to OGG by yourself. Then copy them to the /Mp3 folder and remove the old .mp3 files with e.g. rm -rf *.mp3. You may use those tools for converting MP3 to OGG e.g.: Dirogg Bash Script http://freecode.com/projects/dirogg or the graphical program SoundConverter(sudo yum install soundconverter).

Manual install

Launch vcmiclient to determine data directory (output may differ)

$vcmiclient -v
Starting... 
VCMI 0.91
  data directory:    /usr/share/vcmi
  library directory: /usr/lib/vcmi
  binary directory:  /usr/bin/vcmi

Copy your data to data directory. This should result in directory structure similar to this:

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

Launching game

To start the game type in console:

vcmiclient

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

Reporting bugs

Report any issues with packages on our bugtracker or post a message on VCMI forums In report please post:

  • 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