aboutsummaryrefslogtreecommitdiff
path: root/doc/compiling.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/compiling.tex')
-rw-r--r--doc/compiling.tex84
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/compiling.tex b/doc/compiling.tex
new file mode 100644
index 0000000000..1b1e3adfb3
--- /dev/null
+++ b/doc/compiling.tex
@@ -0,0 +1,84 @@
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "readme"
+%%% End:
+
+\section{Compiling}
+
+You need SDL-1.2.2 or newer (older versions may work, but are unsupported), and
+a supported compiler. Several compilers, including GCC, mingw and Microsoft
+Visual C++ are supported. If you wish to use MP3-compressed CD tracks or
+.SOU files, you will need to install the MAD library and define
+USE\_MAD. Tools for compressing .SOU files to .SO3 files can be
+found in the 'tools' SVN module, or in the 'scummvm-tools' package.
+
+Some parts of ScummVM, particularly scalers, have highly optimized versions
+written in assembler. If you wish to use this option, you will need to install
+nasm assembler (see \url{http://nasm.sf.net}). Note, that currently we have only x86
+MMX optimized versions, and they will not compile on other processors.
+
+On Win9x/NT/XP you can define USE\_WINDBG and attach WinDbg to browse debug
+messages (see \url{http://www.sysinternals.com/ntw2k/freeware/debugview.shtml}).
+
+\subsection{GCC}
+ \begin{itemize}
+ \item Type \texttt{./configure}
+ \item Type \texttt{make} (or \texttt{gmake}, or \texttt{gnumake}, depending
+ on what GNU make is called on your system) and hopefully ScummVM will
+ compile for you.
+ \end{itemize}
+\subsection{Microsoft Visual C++ 6.0}
+ \begin{itemize}
+ \item Open the workspace, scummwm.dsw
+ \item Enter the path to the needed libraries and includes in
+ Tools|Options|Directories
+ \item Now it should compile successfully.
+ \end{itemize}
+\subsection{Microsoft Visual C++ 7.0}
+ \begin{itemize}
+ \item Open the solution file scummwm.sln
+ \item Enter the path to the needed libraries and includes in
+ Tools|Options|Directories
+ \item Now it should compile successfully.
+ \end{itemize}
+\subsection{Windows Mobile with Microsoft eMbedded Visual C++ 3 or 4}
+ \begin{itemize}
+ \item Download SDL with additional Windows Mobile tweaks:\\
+ \url{http://arisme.free.fr/ports/SDL.php}
+ \item Download additional third party libraries:\\
+ \url{http://arisme.free.fr/ports}
+ \item Modify your include and library paths accordingly in EVC3/EVC4.
+ \item Open the ScummVM project dists$\backslash$msevc4$\backslash$PocketSCUMM.vcw
+ \item Modify the libraries and config parameters if necessary.
+ \item Now it should compile successfully.
+ \end{itemize}
+\subsection{Debian GNU/Linux}
+ \begin{itemize}
+ \item Install the packages 'build-essential', 'fakeroot', 'debhelper',
+ and 'libsdl1.2-dev' on your system.
+ \item nstall any of these packages (optional): 'libvorbis-dev' (for Ogg
+ Vorbis support), 'libasound2-dev' (for ALSA sequencer support),
+ 'libmad0-dev' (for MAD MP3 support), 'zlib1g-dev' (for compressed
+ saves support).
+ \item Run 'make deb'
+ \item Finally run 'dpkg -i ../scummvm-cvs*deb', and you're done.
+ \end{itemize}
+\subsection{Mac OS X}
+\begin{itemize}
+\item Make sure you have the developer tools installed.
+\item The SDL developer package for OS X available on the SDL web site is
+ \textit{not} suitable. Rather, you require a unix-style build of SDL. One
+ way to get that is to install SDL via Fink\\
+ (\url{http://fink.sf.net}).
+
+ Alternatively you could compile SDL manually from source using its
+ unix build system\\
+ (\texttt{configure \&\& make}).
+\item Type \texttt{./configure} in the ScummVM directory
+\item You can now type \texttt{make} to create a command line binary.
+\item To get a version you can run from Finder, type \texttt{make bundle} which
+ will create ScummVM.app (this only works if you installed SDL
+ etc. via Fink and into /sw. If you have installed SDL in another
+ way, you'll have to edit the Makefile).
+\end{itemize}