aly/servatrice
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed the Windows howto, it uses the official nsis script now.

Browse source
This commit is contained in:
Mark Morschhäuser 2013-05-08 13:41:43 +02:00
parent a176cf0940
commit 91366a6f43
2 changed files with 14 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/usermanual/Usermanual.pdf
View file

Binary file not shown.

86
doc/usermanual/Usermanual.tex
View file

@ -97,7 +97,7 @@ We need the Cockatrice sourcecode, it's dependencies and build tools. Everything
\item cmake is needed to create Cockatrice's project files for MinGW.
\item Qt 4.8 is a dependency for Cockatrice (download the MinGW version!)
\item protobuf 2.5 is another dependency for Cockatrice (download the zip file with the sourcecode).
\item Optional: Nullsoft Scriptable Install System (NSIS) which can be used to create an installer for your own Cockatrice version.
\item Nullsoft Scriptable Install System (NSIS) which can be used to create an installer for your own Cockatrice version.
\end{enumerate}
All downloadlinks together:
@ -107,13 +107,13 @@ All downloadlinks together:
\item \url{http://www.cmake.org/files/v2.8/cmake-2.8.10.2-win32-x86.exe}
\item \url{http://download.qt-project.org/official_releases/qt/4.8/4.8.4/qt-win-opensource-4.8.4-mingw.exe}
\item \url{http://protobuf.googlecode.com/files/protobuf-2.5.0.zip}
\item Optional: \url{http://nsis.sourceforge.net/Download}
\item \url{http://nsis.sourceforge.net/Download}
\end{enumerate}}
\paragraph{Installation of the Prerequisites}
\begin{enumerate}
\item Download MinGW (mingw-get-inst), git, cmake, protobuf 2.5 sources zip and Qt 4.8.4 MinGW (see links above).
\item Make a standard installation for git and cmake.
\item Make a standard installation for git, cmake and NSIS.
\item Install MinGW:
\begin{enumerate}
\item Select default values everywhere, except: Also check the C++ Compiler, check the MSYS Basis System and MinGW Developer Toolkit.
@ -180,80 +180,22 @@ But if you want to update Cockatrice after the source code changed on github, do
Cockatrice has now been updated and built. You may repeat this process every time when the source code changed.
\paragraph{Cockatrice installation}
You should now install Cockatrice. The command make install does not work completely, but do it anyway (still in the Windows Command Prompt).
Now create the following directory structure somewhere else\footnote{This step could be done from an installer program. Until we have one, you have to do it manually.}:
\begin{verbatim}
Cockatrice
+---plugins
| +---codecs
| +---iconengines
| +---imageformats
+---sounds
+---translations
+---zonebg
\end{verbatim}
To install Cockatrice, you have to create an installer with NSIS now.
Change to the directory \shellcmd{nsis} in the Cockatrice root directory, right click the cockatrice.nsi file and select \shellcmd{Compile NSIS Script}.
The NSIS program then creates a file called cockatrice\_win32\_YYYYmmdd.exe. This is the complete, redistributable installer for your Cockatrice build.
\begin{description}
\item[Cockatrice] contains
\begin{itemize}
\item from the \shellcmd{Cockatrice/build} (check the subdirectories!) and the install directory:
\begin{itemize}
\item cockatrice.exe
\item oracle.exe
\item sounds directory
\item zonebg directory
\end{itemize}
\item from the \shellcmd{C:\textbackslash MinGW\textbackslash bin} directory, the following files (or higher versions):
\begin{itemize}
\item libgcc\_s\_dw2-1.dll
\item libprotobuf-8.dll
\item libstdc++-6.dll
\item mingwm10.dll
\end{itemize}
\item from the \shellcmd{C:\textbackslash Qt\textbackslash 4.8.4\textbackslash bin} directory:
\begin{itemize}
\item QtCore4.dll
\item QtGui4.dll
\item QtMultimedia4.dll
\item QtNetwork4.dll
\item QtSvg4.dll
\item QtXml4.dll
\end{itemize}
\end{itemize}
\item[translations] contains the cockatrice\_XX.qm files from the \shellcmd{Cockatrice\textbackslash build} directory
\item[plugins] contains folders from the \shellcmd{C:\textbackslash Qt\textbackslash 4.8.4\textbackslash plugins} directory:
\begin{itemize}
\item codecs
\item iconengines
\item imageformats
\end{itemize}
\dots but just the dll files, delete the rest.
\end{description}
You are now able to use or deploy Cockatrice.
Now install Cockatrice by executing the installer.
Note: if you installed MinGW or Qt in other than the default paths, you have to fix the paths in the cockatrice.nsi file (also if some libraries change); you can edit this file with a text editor.
You should rename the exe file generated by NSIS to something like Cockatrice\_win32\_YYYYmmdd\_git-HASH.exe, where HASH is the git version you built (start cockatrice.exe after the installation and click the Help $\to$ About Cockatrice menu to find that out, it is a seven character alphanumerical string e.g. bd861bb).
\paragraph{Create a card database}
Before you play or deploy Cockatrice, you should create a card database first:
Start the oracle.exe and let it generate a current cards.xml file:
Start the oracle.exe (the installer does this automatically) and let it generate a current cards.xml file:
\begin{enumerate}
\item File $\to$ Download Sets Information $\to$ OK
\item File $\to$ Download Sets Information $\to$ OK (if there are no MtG sets listed)
\item Check All, Start Download
\end{enumerate}
\paragraph{Optional: Distribute your version of Cockatrice}
If you are going to deploy your Cockatrice version, include the cards.xml in the \shellcmd{Cockatrice} directory and also include the \shellcmd{doc} directory from the Cockatrice source code.
You can redistribute your build the following way:
\begin{enumerate}
\item Create a zip file from your Cockatrice directory, e.g. Cockatrice.zip.
\item Download, install and start the Nullsoft Scriptable Install System (NSIS).
\begin{itemize}
\item Choose \textit{Installer based on ZIP file}, point it to the Cockatrice.zip
\item Default folder can be C:\textbackslash Program Files (x86)
\item Generate, Test
\end{itemize}
\end{enumerate}
You should rename the exe file generated by NSIS to something like Cockatrice\_win32\_DATE\_git-HASH.exe, where DATE is something like 20130507 and HASH is the git version
(start cockatrice.exe and click the Help $\to$ About Cockatrice menu to find that out, it is a seven character alphanumerical string e.g. bd861bb).
Congratulations, you may now use Cockatrice!
\subsubsection{Install latest experimental on Linux}
\begin{enumerate}
@ -832,4 +774,4 @@ If everything succeeded, you should tweak the servatrice.ini and set your root p
%\listoftables
%\printindex
\end{document}
\end{document}