From 1dcd2612c031f04bbb1feca39cf14a053bbcfa62 Mon Sep 17 00:00:00 2001
From: Torbjörn Andersson
Date: Mon, 6 Sep 2004 06:39:31 +0000
Subject: Added a section about sword2mp3 to the documentation. I don't have
 the tools to test the changes to 07_05.tex, though.

svn-id: r14924
---
 README        | 25 +++++++++++++++++++++++++
 doc/07_05.tex | 27 +++++++++++++++++++++++++++
 2 files changed, 52 insertions(+)

diff --git a/README b/README
index 8a5e196d41..a6c0d35a65 100644
--- a/README
+++ b/README
@@ -860,6 +860,31 @@ For Flac add --flac and optional parameters, i.e.
 Eventually you will have a much smaller *.mp3, *.ogg or *.fla file, copy this
 file to your game dir. You can safely remove the old file.
 
+
+7.5.7) Compressing speech/music in Broken Sword 2
+------ ------------------------------------------
+Use our sword2mp3 util rom the scummvm-tools package to perform this task.
+You can choose between multiple target formats, but note  that you can only use
+each if ScummVM was compiled with the respective decoder support enabled.
+
+  sword2mp3 speech1.clu
+  sword2mp3 music1.clu
+
+For Ogg Vorbis add --vorbis to the options, i.e.
+
+  sword2mp3 --vorbis
+
+Eventually you will have a much smaller *.cl3 or *.clg file, copy this file to
+your game dir. You can safely remove the old file.
+
+It is possible to use Flac compression by adding the --flac option. However,
+the resulting *.clf file will actually be larger than the original.
+
+Please note that sword2mp3 will only work with the four speech/music files in
+Broken Sword 2. It will not work with any of the other *.clu files, nor will it
+work with the speech files from Broken Sword 1.
+
+
 7.6) Output sample rate:
 ---- -------------------
 
diff --git a/doc/07_05.tex b/doc/07_05.tex
index 3fa002f444..5261337aa3 100644
--- a/doc/07_05.tex
+++ b/doc/07_05.tex
@@ -113,3 +113,30 @@ For Flac add --flac and optional parameters, i.e.
 %
 Eventually you will have a much smaller *.mp3, *.ogg or *.fla file, copy this
 file to your game dir. You can safely remove the old file.
+
+
+\subsubsection{Compressing speech/music in Broken Sword 2}
+
+Use our sword2mp3 util rom the scummvm-tools package to perform this task.
+You can choose between multiple target formats, but note  that you can only use
+each if ScummVM was compiled with the respective decoder support enabled.
+
+\begin{verbatim}
+  sword2mp3 speech1.clu
+  sword2mp3 music1.clu
+\end{verbatim}
+%
+For Ogg Vorbis add --vorbis to the options, i.e.
+\begin{verbatim}
+  sword2mp3 --vorbis
+\end{verbatim}
+%
+Eventually you will have a much smaller *.cl3 or *.clg file, copy this file to
+your game dir. You can safely remove the old file.
+
+It is possible to use Flac compression by adding the --flac option. However,
+the resulting *.clf file will actually be larger than the original.
+
+Please note that sword2mp3 will only work with the four speech/music files in
+Broken Sword 2. It will not work with any of the other *.clu files, nor will it
+work with the speech files from Broken Sword 1.
-- 
cgit v1.2.3