← Back to branch summary

~ubuntu-branches/debian/squeeze/assaultcube-data/squeeze

« back to all changes in this revision

Viewing changes to docs/getstarted.html

  • Committer: Bazaar Package Importer
  • Author(s): Gonéri Le Bouder
  • Date: 2009-07-30 16:25:27 UTC
  • Revision ID: james.westby@ubuntu.com-20090730162527-v9qil7f02uk8n7b2
Tags: upstream-1.0.2+repack1
Import upstream version 1.0.2+repack1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/getstarted.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN">
 
2
<html lang="en" xml:lang="en" xmlns:h="http://www.w3.org/1999/xhtml" xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
    <title>Get started</title>
 
5
    <meta http-equiv="content-type" content="application/xhtml+xml;charset=utf-8" />
 
6
    <link rel="shortcut icon" href="pics/favicon.ico" />
 
7
    <link rel="stylesheet" href="styles/cubedoc.css" />
 
8
</head>
 
9
<body>
 
10
        <!-- Note: Special thanks to Harps for explaining the permissions of Windows Vista and KanslozeClown for explaining the process for using AC on Mac OS X in regards to this section.-->
 
11
    <div id="main">
 
12
        <div id="logo">
 
13
            <img src="pics/head.gif" alt="AssaultCube logo" />
 
14
        </div>
 
15
        <div id="title">
 
16
            <h1>
 
17
                AssaultCube: Get started</h1>
 
18
        </div>
 
19
        <div id="content">
 
20
            <h1>
 
21
                Get started
 
22
            </h1>
 
23
            <h2 id="requirements">
 
24
                System requirements
 
25
            </h2>
 
26
            <p>
 
27
                If you've played <a href="http://cubeengine.com/cube.php4" target="_blank" shape="rect">
 
28
                    Cube</a> and Cube can run fine, then <a href="http://assault.cubers.net" target="_blank"
 
29
                        shape="rect">AssaultCube</a> should too.
 
30
            </p>
 
31
            <p id="minspecs">
 
32
                <b>Minimum specifications</b> <i><b>Plus, any capable operating system. Capable systems
 
33
                    include:</b> </i>
 
34
            </p>
 
35
            <ul>
 
36
                <li>Processor: Pentium III 500 Mhz (or AMD equivalent).</li>
 
37
                <li>Graphics: GeForce 1 / ATi Radeon or better.</li>
 
38
                <li>Ram: 192 MB ram</li>
 
39
            </ul>
 
40
            <table>
 
41
                <tr>
 
42
                    <td width="50" rowspan="1" colspan="1">
 
43
                        <img src="pics/vista.png" alt="Vista" />
 
44
                    </td>
 
45
                    <td rowspan="1" colspan="1">
 
46
                        <b>Microsoft Windows Vista, XP or 2000</b>
 
47
                        <br clear="none" />
 
48
                        Plus any derivatives of these systems.
 
49
                    </td>
 
50
                </tr>
 
51
                <tr>
 
52
                    <td rowspan="1" colspan="1">
 
53
                        <img src="pics/winold.gif" alt="Windows 98/ME" />
 
54
                    </td>
 
55
                    <td rowspan="1" colspan="1">
 
56
                        <b>Microsoft Windows 98 or ME</b><br clear="none" />
 
57
                        You may find that you need to rename the file <i>DbgHelp_RemoveThisPartIfOnWin98.DLL</i>
 
58
                        in your <i>bin_win32</i> folder to <i>DbgHelp.DLL</i> for AssaultCube to work on
 
59
                        these platforms. 
 
60
                <br clear="none" /><b>Note:</b> The AssaultCube installer should automatically do this for you.
 
61
                    </td>
 
62
                </tr>
 
63
                <tr>
 
64
                    <td rowspan="1" colspan="1">
 
65
                        <img src="pics/linux.png" alt="Linux" />
 
66
                    </td>
 
67
                    <td rowspan="1" colspan="1">
 
68
                        <b>Linux</b><br clear="none" />
 
69
                        You'll need to make sure the appropriate OpenGL drivers are installed, plus these
 
70
                        libraries:<br clear="none" />
 
71
                        * <i>libSDL 1.2</i><br clear="none" />
 
72
                        * <i>libSDL_image</i><br clear="none" />
 
73
                        * <i>OpenAL</i><br clear="none" />
 
74
                        (Note: To use the client provided with the Linux package, you will need <i>OpenAL-Soft</i> instead of
 
75
                        OpenAL, otherwise you will need to compile your own client if you would rather use normal OpenAL).
 
76
                    </td>
 
77
                </tr>
 
78
                <tr>
 
79
                    <td rowspan="1" colspan="1">
 
80
                        <img src="pics/apple.png" alt="Apple" />
 
81
                    </td>
 
82
                    <td rowspan="1" colspan="1">
 
83
                        <b>Mac OS X 10.4</b>
 
84
                        <br clear="none" />
 
85
                        Version 10.4 or higher.                        
 
86
                   </td>
 
87
                </tr>
 
88
                <tr>
 
89
                    <td rowspan="1" colspan="1">
 
90
                        <img src="pics/otheros.png" alt="Other OSes" />
 
91
                    </td>
 
92
                    <td rowspan="1" colspan="1">
 
93
                        <b>Other operating systems</b><br clear="none" />
 
94
                        If you can run the neccesary libraries/drivers and are able to compile the source
 
95
                        by yourself, you may be able to port AssaultCube onto other platforms. Please note:
 
96
                        they may not be officially supported.
 
97
                    </td>
 
98
                </tr>
 
99
            </table>
 
100
            <h3>
 
101
                Low end machines</h3>
 
102
            <p>
 
103
                Please note that the hardware specifications shown above are the bare minimums,
 
104
                so you may need a lot of adjustment to get AssaultCube to run. We recommend that
 
105
                you run AssaultCube on better hardware than this. If you have troubles with AssaultCube,
 
106
                make sure that the drivers for your graphics card are up-to-date.
 
107
            </p>
 
108
            <p>
 
109
                Recommended GFX settings for low/medium end machines:
 
110
            </p>
 
111
            <ul>
 
112
                <li>Resolution: 800x600@16bpp</li>
 
113
                <li>Antialiasing: OFF</li>
 
114
                <li>Anisotropic Filtering: OFF</li>
 
115
            </ul>
 
116
            <h2>
 
117
                Installing AssaultCube</h2>
 
118
            <table>
 
119
                <tr>
 
120
                    <td width="50" rowspan="1" colspan="1">
 
121
                        <img src="pics/vista.png" alt="Vista" />
 
122
                    </td>
 
123
                    <td rowspan="1" colspan="1">
 
124
                        <b>Windows</b><br clear="none" />
 
125
                        Download the executable from Sourceforge. Execute it and follow the instructions.
 
126
                    </td>
 
127
                </tr>
 
128
                <tr>
 
129
                    <td rowspan="1" colspan="1">
 
130
                        <img src="pics/linux.png" alt="Linux" />
 
131
                    </td>
 
132
                    <td rowspan="1" colspan="1">
 
133
                        <b>Linux</b><br clear="none" />
 
134
                        Download the tarball from Sourceforge. Extract it somewhere where you have permissions
 
135
                        to read/write. 
 
136
                    </td>
 
137
                </tr>
 
138
                <tr>
 
139
                    <td rowspan="1" colspan="1">
 
140
                        <img src="pics/apple.png" alt="Apple" />
 
141
                    </td>
 
142
                    <td rowspan="1" colspan="1">
 
143
                        <b>Mac OS X</b><br clear="none" />
 
144
                        Download the diskimage from Sourceforge. Drag the contents to your <i>Applications</i>
 
145
                        folder.
 
146
                    </td>
 
147
                </tr>
 
148
                <tr>
 
149
                    <td rowspan="1" colspan="1">
 
150
                        <img src="pics/otheros.png" alt="Other OSes" />
 
151
                    </td>
 
152
                    <td rowspan="1" colspan="1">
 
153
                        <b>Other operating systems</b><br clear="none" />
 
154
                        You will need to gather the libraries and drivers needed for AssaultCube by yourself.
 
155
                        You will then need to compile AssaultCube from source. For this, you'll need to
 
156
                        download the tarball from Sourceforge.
 
157
                    </td>
 
158
                </tr>
 
159
            </table>
 
160
            <p>
 
161
                <i>More help for installing AssaultCube on different Operating Systems can be found
 
162
                    on the wiki <a href="http://assault.cubers.net/wiki/Running_AC_on_different_platforms"
 
163
                        target="_blank" shape="rect">here</a>. </i>
 
164
            </p>
 
165
            <h2>
 
166
                Running AssaultCube
 
167
            </h2>
 
168
            <table>
 
169
                <tr>
 
170
                    <td width="50" rowspan="1" colspan="1">
 
171
                        <img src="pics/vista.png" alt="Vista" />
 
172
                    </td>
 
173
                    <td rowspan="1" colspan="1">
 
174
                        <b>Windows</b><br clear="none" />
 
175
                        Use the shortcut provided. Or execute the <i>assaultcube.bat</i> file in your AssaultCube
 
176
                        folder.
 
177
                    </td>
 
178
                </tr>
 
179
                <tr>
 
180
                    <td rowspan="1" colspan="1">
 
181
                        <img src="pics/linux.png" alt="Linux" />
 
182
                    </td>
 
183
                    <td rowspan="1" colspan="1">
 
184
                        <b>Linux</b><br clear="none" />
 
185
                        In a console, change your location (cd) to the main AssaultCube directory and then
 
186
                        execute <i>assaultcube.sh</i>.
 
187
                    </td>
 
188
                </tr>
 
189
                <tr>
 
190
                    <td rowspan="1" colspan="1">
 
191
                        <img src="pics/apple.png" alt="Apple" />
 
192
                    </td>
 
193
                    <td rowspan="1" colspan="1">
 
194
                        <b>Mac OS X</b><br clear="none" />
 
195
                        Open the applications folder. Click on AssaultCube. Select the options you want
 
196
                        to use to run AssaultCube and then press <i>play</i>.
 
197
                    </td>
 
198
                </tr>
 
199
            </table>
 
200
            <h2>
 
201
                Special notes</h2>
 
202
            <p>
 
203
                <b>Users of Windows Vista:</b>
 
204
                <br clear="none" />
 
205
                <b>Note:</b> Files that AssaultCube writes during the game (such as screenshots, configs
 
206
                and maps) get saved in a seperate folder inside your "My Documents".
 
207
            </p>
 
208
            <p>
 
209
                <b>Users of Linux:</b>
 
210
                <br clear="none" />
 
211
                <b>Note:</b> Files that AssaultCube writes during the game (such as screenshots, configs
 
212
                and maps) get saved in the hidden <i>.assaultcube</i> folder in your users home
 
213
                directory.
 
214
            </p>
 
215
            <p>
 
216
                <b>Sound problems:</b>
 
217
                <br clear="none" />
 
218
                                Read the <a href="http://assault.cubers.net/wiki/Sounds" shape="rect">sounds page</a> on the wiki.
 
219
            </p>
 
220
            <h2>
 
221
                Display settings
 
222
            </h2>
 
223
            <p>
 
224
                When you first start AssaultCube, you will be prompted to change some fundamental
 
225
                settings from their defaults to how you would like them. Some display settings can
 
226
                be changed here. To change more display settings, press ESCAPE and then navigate to: Settings &rarr; Video
 
227
                Settings.
 
228
            </p>
 
229
            <p>
 
230
                If you are having technical problems and need to change settings in a way that doesn't
 
231
                start the game to do it, you can modify the batch/shell script by adding parameters
 
232
                into it. How to edit the batch/shell and the different parameters can be found in
 
233
                <a href="commandline.html" shape="rect">command-line arguments</a>. You can also
 
234
                add <a href="reference.xml" shape="rect">commands</a> to <i>config/autoexec.cfg</i>
 
235
                so they automatically execute on startup.
 
236
            </p>
 
237
                        <p>
 
238
                          A lot of information about graphics can be found in the <a href="graphicsdrivers.html" shape="rect">graphics guide</a>.
 
239
                        </p>
 
240
        </div>
 
241
        <div id="footer">
 
242
            Rabid Viper Productions
 
243
        </div>
 
244
    </div>
 
245
</body>
 
246
</html>