https://wiki.vcmi.eu/api.php?action=feedcontributions&user=Giff&feedformat=atomVCMI Project Wiki - User contributions [en]2024-03-28T22:33:16ZUser contributionsMediaWiki 1.28.2https://wiki.vcmi.eu/index.php?title=Installation_on_Linux&diff=1722Installation on Linux2014-11-01T16:55:46Z<p>Giff: /* Reporting bugs */</p>
<hr />
<div>VCMI requires data from original Heroes 3: Shadow of Death or Complete editions. Data from native Linux version made by LOKI will not work.<br />
= Binaries installation =<br />
== Ubuntu ==<br />
VCMI can be installed from PPA:<br />
<br />
* stable version (recommended): https://launchpad.net/~saven-ivan/+archive/vcmi<br />
* daily builds (for testing only): https://launchpad.net/~vcmi/+archive/ppa<br />
<br />
To use it type in Terminal:<br />
<pre><br />
sudo apt-add-repository ppa:saven-ivan/vcmi<br />
sudo apt-get update<br />
sudo apt-get install vcmi<br />
</pre><br />
<br />
== Debian ==<br />
Download and install package for your distribution. Install can be done using any GUI managers or using command line:<br />
<pre><br />
sudo dpkg -i downloaded_package.deb<br />
sudo apt-get -f install<br />
</pre><br />
Note: First command most probably will result in errors - this is normal behavior, all of them should be fixed by second one.<br />
<br />
{|<br />
|'''Debian Wheezy'''<br />
|[http://download.vcmi.eu/vcmi_0.96_i386.deb 32 bit]<br />
|[http://download.vcmi.eu/vcmi_0.96_amd64.deb 64 bit]<br />
|}<br />
<br />
== Fedora ==<br />
'''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.<br />
<br />
Download and install package for your distribution. There are two ways to install package along with all dependencies: <br />
<br />
Option A) Double-click the package. A package management window should appear with instructions to guide you through the process.<br />
<br />
Option B) Open a terminal window, and type <br />
<pre><br />
sudo rpm -i package_location_and_name(e.g. vcmi-0.9.5-1.fc20.x86_64.rpm)<br />
</pre><br />
<br />
{|<br />
|'''Fedora 20 (VCMI 0.95)'''<br />
|[https://www.dropbox.com/s/ieonm9ot3qstylm/vcmi-0.9.5-1.fc20.i686.rpm 32 bit]<br />
|[https://www.dropbox.com/s/vd6g0fp68b5vw53/vcmi-0.9.5-1.fc20.x86_64.rpm 64 bit]<br />
|}<br />
<br />
== Other distributions ==<br />
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<br />
* Archlinux [https://aur.archlinux.org/packages/vcmi/ vcmi] [https://aur.archlinux.org/packages/vcmi-git/ vcmi-git]<br />
<br />
== Compiling from source ==<br />
* [http://download.vcmi.eu/vcmi-0.96.tar.gz Packaged source for latest version]<br />
* [https://github.com/vcmi/vcmi/releases Alternative download links on github]<br />
* [https://github.com/vcmi/vcmi/blob/develop/README.linux Readme] (available as README.linux in source package)<br />
<br />
Be careful about proper installation of VCMI. The game copies some files from its source distribution at first run, so you must use make install to install the game properly. Otherwise, the game won't be able to find resource files.<br />
If you don't want to pollute your filesystem with game files, use the following way of installing the game:<br />
<br />
<pre><br />
# cmake -DCMAKE_INSTALL_PREFIX=absolute_path_to_binaries ../vcmi<br />
# make && make install<br />
# cd absolute_path_to_binaries<br />
# ./bin/vcmiclient<br />
</pre><br />
<br />
= Installing Heroes III data files =<br />
To install VCMI you will need:<br />
* Heroes III: Shadow of Death or Complete edition<br />
* Unnoficial WoG addon: http://download.vcmi.eu/WoG/wog.zip<br />
* VCMI data files: http://download.vcmi.eu/core.zip<br />
== Automated install ==<br />
To install Heroes 3 data using automated script you need any of:<br />
* One or two CD's or CD images<br />
* gog.com installer<br />
* Directory with installed game<br />
<br />
Run the script using options appropriate to your input files:<br />
<pre><br />
vcmibuilder --cd1 /path/to/iso/or/cd --cd2 /path/to/second/cd --download<br />
vcmibuilder --gog /path/to/gog.com/installer --download<br />
vcmibuilder --data /path/to/h3/data --download<br />
</pre><br />
You should use only one of these commands.<br />
<br />
=== Offline install ===<br />
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:<br />
<pre><br />
vcmibuilder <h3 data commands> --wog /path/to/wog/archive --vcmi /path/to/vcmi/package<br />
</pre><br />
Where '''h3 data commands''' stands for described earlier option(s) needed to install H3 data (path to data, Install CD or gog.com installer)<br />
<br />
=== Fedora music support ===<br />
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.<br />
<br />
To make music work it must be converted into ogg format. This can be done either manually or using vcmibuilder:<br />
<pre><br />
vcmibuilder --convertMP3<br />
</pre><br />
This command can be run separately after install or as additional switch during initial vcmibuilder launch<br />
<br />
== Manual install ==<br />
<br />
* Install Heroes III<br />
* Extract WoG addon http://download.vcmi.eu/WoG/wog.zip<br />
* Extract VCMI data files: http://download.vcmi.eu/core.zip<br />
<br />
Launch vcmiclient to determine data directory (output may differ)<br />
<pre><br />
$vcmiclient -v<br />
Starting... <br />
VCMI 0.91<br />
data directory: /usr/share/vcmi<br />
library directory: /usr/lib/vcmi<br />
binary directory: /usr/games<br />
</pre><br />
Copy your data to data directory. This should result in directory structure similar to this:<br />
<pre><br />
/usr/share/vcmi/config/<br />
/usr/share/vcmi/Data/<br />
/usr/share/vcmi/Maps/<br />
/usr/share/vcmi/Mods/WoG/<br />
/usr/share/vcmi/Mods/vcmi/<br />
/usr/share/vcmi/Mp3/<br />
</pre><br />
<br />
= Launching game =<br />
To start the game type in console:<br />
<pre><br />
vcmiclient<br />
</pre><br />
VCMI should be also available via desktop environment menu or launcher (Games/Strategy/VCMI)<br />
= Reporting bugs =<br />
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]<br />
In report please proceed according to <br />
[http://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines Bug reporting guidelines]</div>Giffhttps://wiki.vcmi.eu/index.php?title=Main_Page&diff=1675Main Page2014-07-20T19:36:31Z<p>Giff: /* Latest release */</p>
<hr />
<div>__NOTOC__<br />
= Welcome to VCMI Project Wiki =<br />
<br />
[[VCMI]] is an open-source project aiming to reimplement HMM3:WoG game engine, giving it new and extended possibilities.<br />
<br />
== Latest release ==<br />
Latest released version is <strong>0.96</strong>.<br />
* [http://forum.vcmi.eu/viewtopic.php?t=933 Information about build]<br />
<br />
== Documentation and guidelines for users ==<br />
* [[VCMI | General information about VCMI Project]]<br />
* [[Frequently asked questions]]<br />
* [[Engine features]]<br />
* [[Game mechanics]]<br />
* [[Bug reporting guidelines]]<br />
* [[Installation on Linux]]<br />
* [http://www.4shared.com/file/135714811/d0214227/vcmimanual.html Manual]<br />
* [http://spreadsheets.google.com/ccc?key=pRhYM0YkAF9lIpLe4raNAWA List of implemented game items]<br />
* [[Mod list]]<br />
* [[Modding guidelines]]<br />
<br />
== Documentation and guidelines for developers ==<br />
* How to build:<br />
** [[How_to_build_VCMI_(Windows/Cmake)|Windows/Cmake]]<br />
** [[How_to_build_VCMI_(Windows/Codeblocks)|Windows/Code::Blocks]]<br />
** [[How_to_build_VCMI_(Windows)|Windows/MSVS]]<br />
** [[How_to_build_VCMI_(Linux)|Linux]]<br />
** [[How_to_build_VCMI_(OS_X)|OS X]]<br />
* [[Code structure]]<br />
* [[Logging API]]<br />
* [[Coding guidelines]]<br />
* [[TODO list]]<br />
<br />
Links for developers:<br />
* [https://github.com/vcmi/vcmi Git repository]<br />
* [http://svn.code.sf.net/p/vcmi/code/trunk/ The old SVN repository (not used anymore)]<br />
<br />
== VCMI Places ==<br />
* [http://forum.vcmi.eu/portal.php Portal]<br />
* [http://forum.vcmi.eu/ Forum]<br />
* [http://bugs.vcmi.eu/ Bugtracker]</div>Giffhttps://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines&diff=1674Bug reporting guidelines2014-07-20T19:15:33Z<p>Giff: paths reflects http://forum.vcmi.eu/viewtopic.php?t=858</p>
<hr />
<div>First of all, thanks for your support! <br />
If you report a bug we can fix it. But keep in mind that reporting your bugs appropriately makes our (developers') lifes easier. Here are a few guidelines that will help you write good bug reports.<br />
<br />
= Mantis bugtracker =<br />
<br />
The main place for managing and reporting bugs is [http://bugs.vcmi.eu/ our bugtracker]. When you are not logged in, you can only browse already reported bugs. To be able to report bugs you need to make an account there.<br />
<br />
== What should be reported ==<br />
<br />
Certainly the most important bugs we would like to know about are crashes and game hangs. Game should not crash nor hang under any conditions. But bugs are not restricted to those extreme cases. Graphical glitches, significant differences in game mechanics from WoG (in this case remember that not everything is implemented yet, we usually don't call missing features as bugs; see [[TODO_list|TODO list]] for details about what is still to be done) and serious performance drops should be reported too.<br />
<br />
== What to focus on while testing ==<br />
<br />
There are no specific guidelines on this. Every part of the game needs some attention while testing. Usually newly added features should be tested more. Sometimes bugs occur only when loading from savegame, so you shouldn't always begin a new game.<br />
<br />
== General guidelines ==<br />
<br />
First of all, if you encounter a crash, don't re-run VCMI immediately to see if you can reproduce it. Firstly take a screenshot or copy console output (those mostly green letters on black background). Then back up following files (if you won't be able to reproduce the issue you should upload them with issue report):<br />
* VCMI_Client_log.txt<br />
* VCMI_Server_log.txt<br />
* VCMI_Client.exe_crashinfo.dmp (if present)<br />
* VCMI_Server.exe_crashinfo.dmp (if present)<br />
<br />
Log files are written to:<br />
* Windows: Users/*your_user_name*/vcmi/<br />
* UNIX: ~/.cache/vcmi/ (~/.vcmi for version 0.95 and earlier)<br />
<br />
Now you should try to reproduce encountered issue. It's best when you write how to reproduce the issue by starting a new game and taking some steps (e.g. start Arrogance map as red player and attack monster Y with hero X). If you have troubles with reproducing it this way but you can do it from a savegame - that's good too. Finally, when you are not able to reproduce the issue at all, just upload the files mentioned above. To sum up, this is a list of what's the most desired for a developer: <br />
# (most desired) a map with list of steps needed to reproduce the bug <br />
# savegame with list of steps to reproduce the bug <br />
# (least desired) VCMI_Client_log.txt, VCMI_Server_log.txt, console log and crashdump (you should use this option only when bug is not reproducible but then remember to back logs up before trying to reproduce it).<br />
<br />
== How to set the log level to debug ==<br />
If you want to set the log level to debug or trace to let developers know what went wrong or to write a bug report, then you should first open your <tt>settings.json</tt> with a text editor. The file is located at:<br />
* Windows: Heroes III location/config<br />
* UNIX: ~/.config/vcmi/ (~/.vcmi/config for version 0.95 and earlier)<br />
<br />
Add the "logging" : { ... } part to the file, that it may look like this:<br />
<syntaxhighlight lang="javascript"><br />
{<br />
"logging" : {<br />
"loggers" : [<br />
{<br />
"domain" : "global",<br />
"level" : "debug"<br />
}<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
You can substitute the value debug with trace to log traces as well.</div>Giffhttps://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines&diff=1673Bug reporting guidelines2014-07-20T19:07:56Z<p>Giff: typo</p>
<hr />
<div>First of all, thanks for your support! <br />
If you report a bug we can fix it. But keep in mind that reporting your bugs appropriately makes our (developers') lifes easier. Here are a few guidelines that will help you write good bug reports.<br />
<br />
= Mantis bugtracker =<br />
<br />
The main place for managing and reporting bugs is [http://bugs.vcmi.eu/ our bugtracker]. When you are not logged in, you can only browse already reported bugs. To be able to report bugs you need to make an account there.<br />
<br />
== What should be reported ==<br />
<br />
Certainly the most important bugs we would like to know about are crashes and game hangs. Game should not crash nor hang under any conditions. But bugs are not restricted to those extreme cases. Graphical glitches, significant differences in game mechanics from WoG (in this case remember that not everything is implemented yet, we usually don't call missing features as bugs; see [[TODO_list|TODO list]] for details about what is still to be done) and serious performance drops should be reported too.<br />
<br />
== What to focus on while testing ==<br />
<br />
There are no specific guidelines on this. Every part of the game needs some attention while testing. Usually newly added features should be tested more. Sometimes bugs occur only when loading from savegame, so you shouldn't always begin a new game.<br />
<br />
== General guidelines ==<br />
<br />
First of all, if you encounter a crash, don't re-run VCMI immediately to see if you can reproduce it. Firstly take a screenshot or copy console output (those mostly green letters on black background). Then back up following files (if you won't be able to reproduce the issue you should upload them with issue report):<br />
* VCMI_Client_log.txt<br />
* VCMI_Server_log.txt<br />
* VCMI_Client.exe_crashinfo.dmp (if present)<br />
* VCMI_Server.exe_crashinfo.dmp (if present)<br />
<br />
Log files are written to:<br />
* Windows: Users/*your_user_name*/vcmi/<br />
* UNIX: ~/.cache/vcmi/ (~/.vcmi for version 0.95 and earlier)<br />
<br />
Now you should try to reproduce encountered issue. It's best when you write how to reproduce the issue by starting a new game and taking some steps (e.g. start Arrogance map as red player and attack monster Y with hero X). If you have troubles with reproducing it this way but you can do it from a savegame - that's good too. Finally, when you are not able to reproduce the issue at all, just upload the files mentioned above. To sum up, this is a list of what's the most desired for a developer: <br />
# (most desired) a map with list of steps needed to reproduce the bug <br />
# savegame with list of steps to reproduce the bug <br />
# (least desired) VCMI_Client_log.txt, VCMI_Server_log.txt, console log and crashdump (you should use this option only when bug is not reproducible but then remember to back logs up before trying to reproduce it).<br />
<br />
== How to set the log level to debug ==<br />
If you want to set the log level to debug or trace to let developers know what went wrong or to write a bug report, then you should first open your <tt>settings.json</tt> with a text editor. The file is located at:<br />
* Windows: Heroes III location/config<br />
* UNIX: ~./vcmi/config<br />
<br />
Add the "logging" : { ... } part to the file, that it may look like this:<br />
<syntaxhighlight lang="javascript"><br />
{<br />
"logging" : {<br />
"loggers" : [<br />
{<br />
"domain" : "global",<br />
"level" : "debug"<br />
}<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
You can substitute the value debug with trace to log traces as well.</div>Giffhttps://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines&diff=1672Bug reporting guidelines2014-07-20T19:06:18Z<p>Giff: /* General guidelines */</p>
<hr />
<div>First of all, thanks for your support! <br />
If you report a bug we can fix it. But keep in mind that reporting your bugs appropriately makes our (developers') lifes easier. Here are a few guidelines that will help you write good bug reports.<br />
<br />
= Mantis bugtracker =<br />
<br />
The main place for managing and reporting bugs is [http://bugs.vcmi.eu/ our bugtracker]. When you are not logged in, you can only browse already reported bugs. To be able to report bugs you need to make an account there.<br />
<br />
== What should be reported ==<br />
<br />
Certainly the most important bugs we would like to know about are crashes and game hangs. Game should not crash nor hang under any conditions. But bugs are not restricted to those extreme cases. Graphical glitches, significant differences in game mechanics from WoG (in this case remember that not everything is implemented yet, we usually don't call missing features as bugs; see [[TODO_list|TODO list]] for details about what is still to be done) and serious performance drops should be reported too.<br />
<br />
== What to focus on while testing ==<br />
<br />
There are no specific guidelines on this. Every part of the game needs some attention while testing. Usually newly added features should be tested more. Sometimes bugs occur only when loading from savegame, so you shouldn't always begin a new game.<br />
<br />
== General guidelines ==<br />
<br />
First of all, if you encounter a crash, don't re-run VCMI immediately to see if you can reproduce it. Firstly take a screenshot or copy console output (those mostly green letters on black background). Then back up following files (if you won't be able to reproduce the issue you should upload them with issue report):<br />
* VCMI_Client_log.txt<br />
* VCMI_Server_log.txt<br />
* VCMI_Client.exe_crashinfo.dmp (if present)<br />
* VCMI_Server.exe_crashinfo.dmp (if present)<br />
<br />
Log files are written to:<br />
* Windows: Users/*your_user_name*/vcmi/<br />
* UNIX: ~/.cache/vcmi/ (~/.vcmi for version 0.95 and earlier)<br />
<br />
Now you should try to reproduce encountered issue. It's best when you write how to reproduce the issue by starting a new game and taking some steps (e.g. start Arrogance map as red player and attack monster Y with hero X). If you have troubles with reproducing it this way but you can do it from a savegame - that's good too. Finally, when you are not able to reproduce the issue at all, just upload the files mentioned above. To sum up, this is a list of what's the most desired for a developer: <br />
# (most desired) a map with list of steps needed to reproduce the bug <br />
# savegame with list of steps to reproduce the bug <br />
# (least desired) VCMI_Client_log.txt, VCMI_Server_log.txt, console log and crashdump (you should use this option only when bug is not reproducible but then remember to backup logs up before trying to reproduce it).<br />
<br />
== How to set the log level to debug ==<br />
If you want to set the log level to debug or trace to let developers know what went wrong or to write a bug report, then you should first open your <tt>settings.json</tt> with a text editor. The file is located at:<br />
* Windows: Heroes III location/config<br />
* UNIX: ~./vcmi/config<br />
<br />
Add the "logging" : { ... } part to the file, that it may look like this:<br />
<syntaxhighlight lang="javascript"><br />
{<br />
"logging" : {<br />
"loggers" : [<br />
{<br />
"domain" : "global",<br />
"level" : "debug"<br />
}<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
You can substitute the value debug with trace to log traces as well.</div>Giffhttps://wiki.vcmi.eu/index.php?title=Bug_reporting_guidelines&diff=1671Bug reporting guidelines2014-07-20T19:03:21Z<p>Giff: paths reflects http://forum.vcmi.eu/viewtopic.php?t=858</p>
<hr />
<div>First of all, thanks for your support! <br />
If you report a bug we can fix it. But keep in mind that reporting your bugs appropriately makes our (developers') lifes easier. Here are a few guidelines that will help you write good bug reports.<br />
<br />
= Mantis bugtracker =<br />
<br />
The main place for managing and reporting bugs is [http://bugs.vcmi.eu/ our bugtracker]. When you are not logged in, you can only browse already reported bugs. To be able to report bugs you need to make an account there.<br />
<br />
== What should be reported ==<br />
<br />
Certainly the most important bugs we would like to know about are crashes and game hangs. Game should not crash nor hang under any conditions. But bugs are not restricted to those extreme cases. Graphical glitches, significant differences in game mechanics from WoG (in this case remember that not everything is implemented yet, we usually don't call missing features as bugs; see [[TODO_list|TODO list]] for details about what is still to be done) and serious performance drops should be reported too.<br />
<br />
== What to focus on while testing ==<br />
<br />
There are no specific guidelines on this. Every part of the game needs some attention while testing. Usually newly added features should be tested more. Sometimes bugs occur only when loading from savegame, so you shouldn't always begin a new game.<br />
<br />
== General guidelines ==<br />
<br />
First of all, if you encounter a crash, don't re-run VCMI immediately to see if you can reproduce it. Firstly take a screenshot or copy console output (those mostly green letters on black background). Then back up following files (if you won't be able to reproduce the issue you should upload them with issue report):<br />
* VCMI_Client_log.txt<br />
* VCMI_Server_log.txt<br />
* VCMI_Client.exe_crashinfo.dmp (if present)<br />
* VCMI_Server.exe_crashinfo.dmp (if present)<br />
<br />
Log files are written to:<br />
* Windows: Users/*your_user_name*/vcmi/<br />
* UNIX: ~/.cache/vcmi/ (~/.vcmi for version 0.95 and earlier)<br />
<br />
Now you should try to reproduce encountered issue. It's best when you write how to reproduce the issue by starting a new game and taking some steps (e.g. start Arrogance map as red player and attack monster Y with hero X). If you have troubles with reproducing it this way but you can do it from a savegame - that's good too. Finally, when you are not able to reproduce the issue at all, just upload upload the files mentioned above. To sum up, this is a list of what's the most desired for a developer: <br />
# (most desired) a map with list of steps needed to reproduce the bug <br />
# savegame with list of steps to reproduce the bug <br />
# (least desired) VCMI_Client_log.txt, VCMI_Server_log.txt, console log and crashdump (you should use this option only when bug is not reproducible but then remember to back logs up before trying to reproduce it).<br />
<br />
== How to set the log level to debug ==<br />
If you want to set the log level to debug or trace to let developers know what went wrong or to write a bug report, then you should first open your <tt>settings.json</tt> with a text editor. The file is located at:<br />
* Windows: Heroes III location/config<br />
* UNIX: ~./vcmi/config<br />
<br />
Add the "logging" : { ... } part to the file, that it may look like this:<br />
<syntaxhighlight lang="javascript"><br />
{<br />
"logging" : {<br />
"loggers" : [<br />
{<br />
"domain" : "global",<br />
"level" : "debug"<br />
}<br />
]<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
You can substitute the value debug with trace to log traces as well.</div>Giff