1Installation Instructions
2*************************
3
4
5Original Game Data Files
6========================
7  Due to licence restrictions, we don't distribute the original game data
8files. You should have a copy of Syndicate or buy it. In order to run
9FreeSynd, either copy all files from the original Syndicate "DATA" directory
10into the FreeSynd "data" directory, or edit the FreeSynd configuration to
11indicate where the original game's "DATA" directory is (see "Configuring FreeSynd" below).
12At first run Freesynd will test files located in your Syndicate "DATA" directory
13to verify that required files are present and are correct.
14
15====> Attention: Please, be sure to have files from the first version of
16Syndicate as FreeSynd does not support files from Syndicate Plus or Syndicate
17Wars.
18
19
20Required Libraries
21==================
22  Freesynd needs the following libraries to build and run :
23    - libSDL-1.2
24    - libSDL_mixer
25    - libSDL_image
26    - libpng
27
28  On Windows, all libraries are released with the game. You don't have to
29install anything.
30
31  Most popular Linux distributions already have packages for these libraries.
32Use your distribution's package manager to install those libraries.
33
34  For other distributions, consult the appropriate documentation.
35
36
37Install and Run Freesynd
38========================
39
40  * From binary distribution file
41    =============================
42
43     * Windows
44     ---------
45        1/ Download and unzip the file in any directory you want.
46           This directory will be called FS_ROOT in the following text.
47	2/ Install original game data files (see chapter "Original Game Data).
48	3/ Optionnaly edit FS_ROOT/bin/freesynd.ini to indicate where to find original
49	   game data files (see chapter "Configuring FreeSynd")
50	4/ Run FS_ROOT/bin/freesynd.exe.
51
52    * Mac Installation
53    ------------------
54        1/ Unzip the application bundle and drag it to your "Applications" folder.
55
56    * Linux Installation
57    ------------------
58      See next chapter : Building from source
59
60
61  * Building from packaged source
62    =============================
63    * All
64    -----
65	1/ To build Freesynd, you will need to install Cmake (http://www.cmake.org/)
66	or use your distribution's package manager to install it.
67	2/ Download and unzip file containing source code in any directory you want
68	   This directory will be called FS_ROOT in the following text.
69
70    * Windows - Visual C++
71    ----------------------
72    Run cmake-gui.
73    Set "Source" to FS_ROOT/sources.
74    Set "Build" to the folder where your project files should be located.
75    Click "Configure" and select your version of Visual Studio.
76    Click "Finish".
77    Click "Generate" to generate Visual Studio project files.
78    Run Visual Studio.
79    Select "File | Open Solution" and pick "freesynd.sln" in the build folder.
80    From "Build | Configuration Manager...", choose the configuration you want.
81    Select "Build | Clean Solution".
82    Select "Build | Build Solution".
83
84	To run the application, you need to copy all dll files that are in FS_ROOT/bin
85	to the directory where the feesynd.exe file has been generated.
86
87    * Windows - Code::Blocks with MinGW
88    -----------------------------------
89	Run cmake-gui.
90    Set "Source" to FS_ROOT/sources.
91    Set "Build" to the folder where your project files should be located
92	    it could be for example FS_ROOT/debug if you use the Debug build configuration.
93    Click "Configure" and select CodeBlocks - MinGW Makefiles.
94    Click "Finish".
95	You can set the CMAKE_BUILD_TYPE variable to "release" or "debug" to enable one of the configuration
96	  - by default,	it's set to "debug".
97    Click "Generate" to generate Code::Blocks project files.
98	Open CodeBlocks IDE, select "File | Open..." and select "FreeSynd.cbp" in the build folder.
99	Select "Build | Build"
100	The freesynd binary will be in the "src" folder.
101
102	To run the application, you need to copy all dll files that are in FS_ROOT/bin
103	to the directory where the feesynd.exe file has been generated.
104
105    * Linux
106    -------
107    Use your distribution's package manager to install all of
108    the libraries listed in the chapter "Required Libraries".
109    From FS_ROOT folder, run the following commands:
110      Run cmake to create Makefiles in release mode :
111        ./configure --release
112
113      Build the application. The freesynd binary will be in
114      the "src" folder :
115        make
116
117      Install the application :
118	sudo make install
119
120      Run the application
121	freesynd
122
123      Optionnaly edit freesynd.ini to indicate where to find original
124	   game data files (see chapter "Configuring FreeSynd")
125
126    * Mac
127    -----
128    Install CMake from http://www.cmake.org/ .
129    Install SDL.framework from http://www.libsdl.org/download-1.2.php
130    Install SDL_image.framework from http://www.libsdl.org/projects/SDL_image/
131    Install SDL_mixer.framework from http://www.libsdl.org/projects/SDL_mixer/
132    Run: export PATH="$PATH:/Applications/CMake 2.8-4.app/Contents/bin"
133    From the main source folder, run: cmake .
134    Finally, run: make
135    The FreeSynd application will be in the "src" folder.
136
137	type make install
138	Double-click on the FreeSynd application.
139
140
141Configuring FreeSynd
142====================
143  FreeSynd reads the file freesynd.ini to get its running configuration.
144You can edit the file with any text editor to customize your installation.
145When you run FreeSynd, a default ini file will be created for you if it does
146not already exist.
147
148  The location of freesynd.ini is different on each platform.
149  * Windows: the folder containing freesynd.exe
150  * Linux: $HOME/.freesynd/
151  * Mac: $HOME/Library/Application Support/FreeSynd/
152
153  (For Mac users who prefer the Linux/Unix way of doing things, a symlink will
154be created at $HOME/.freesynd for your convenience.)
155
156  The default location of freesynd.ini can be overridden on the command line.
157Run freesynd --help to see usage information.
158
159  Here is a description of each of the config file parameters:
160    * test_data: (true/false) If true, the game will look for Original Syndicate
161    Data and test it
162    * fullscreen: (true/false) If true, the game will run in fullscreen mode.
163    * play_intro: (true/false) If true, the introduction will be played.
164    * freesynd_data_dir: Path to the FreeSynd "data" directory. This parameter
165    should have a sensible default. Only set this if you really need to.
166    * data_dir: Path to the original Syndicate "DATA" directory. By default,
167    this will be the same as freesynd_data_dir.
168    * language: 0:english, 1:français, 2:italiano, 3:deutsch
169
170  After launch, play_intro will be turned off automatically.
171
172
173Saved Games
174===========
175  Saved games are located in a different place on each platform.
176
177  * Windows: the folder containing freesynd.exe, + "save"
178  * Linux: $HOME/.freesynd/save/
179  * Mac: $HOME/Library/Application Support/FreeSynd/save/
180
181  You may note that this location is based on the default ini file location.
182The saved games location will not be affected by specifying a different path
183for the ini file on the command line.
184
185