diff --git a/docs/getstarted.xml b/docs/getstarted.xml index f6cf96ea..062e5da5 100644 --- a/docs/getstarted.xml +++ b/docs/getstarted.xml @@ -25,47 +25,57 @@ Plus, any capable operating system. Capable systems include:

- -

- - Microsoft Windows Vista, XP or 2000 -
Plus any derivatives of these systems. -

- -

- - Microsoft Windows 98 or ME
- You may find that you need to rename the file DbgHelp_RemoveThisPartIfOnWin98.DLL - in your bin_win32 folder to DbgHelp.DLL for AssaultCube to work on these platforms. -

- -

- - Linux
You'll need to make sure the appropriate OpenGL drivers are installed, plus these libraries: -

- - - -

- Mac OS X -

- -

- - Other operating systems
- If you can run the neccesary libraries/drivers and are able to compile the source by yourself, you - may be able to port AssaultCube onto other platforms. Please note: they may not be officially supported. -

+ + + + + + + + + + + + + + + + + + + + + +
+ + + Microsoft Windows Vista, XP or 2000 +
Plus any derivatives of these systems. +
+ + + Microsoft Windows 98 or ME
+ You may find that you need to rename the file DbgHelp_RemoveThisPartIfOnWin98.DLL + in your bin_win32 folder to DbgHelp.DLL for AssaultCube to work on these platforms. +
+ + + Linux
+ You'll need to make sure the appropriate OpenGL drivers are installed, plus these libraries:
+ * libSDL 1.2
+ * libSDL_image
+ * OpenAL +
+ + + Mac OS X +
+ + + Other operating systems
+ If you can run the neccesary libraries/drivers and are able to compile the source by yourself, you + may be able to port AssaultCube onto other platforms. Please note: they may not be officially supported. +

Low end machines

@@ -83,34 +93,98 @@

Installing AssaultCube

- -

- - Windows
- Download the executable from sourceforge. Execute it and follow the instructions. -

-

- - Linux
- Download the tarball from sourceforge. Extract it somewhere where you have permissions - to read/write. -

-

- - Mac OS X
- Download the diskimage from sourceforge. Drag the contents to your Applications folder. -

-

- - Other operating systems
- You will need to gather the libraries and drivers needed for AssaultCube by yourself. You will then need - to compile AssaultCube from source. For this, you'll need to download the tarball from sourceforge. -

+ + + + + + + + + + + + + + + + + +
+ + + Windows
+ Download the executable from sourceforge. Execute it and follow the instructions. +
+ + + Linux
+ Download the tarball from sourceforge. Extract it somewhere where you have permissions + to read/write. +
+ + + Mac OS X
+ Download the diskimage from sourceforge. Drag the contents to your Applications folder. +
+ + + Other operating systems
+ You will need to gather the libraries and drivers needed for AssaultCube by yourself. You will then need + to compile AssaultCube from source. For this, you'll need to download the tarball from sourceforge. +

More help for installing AssaultCube on different Operating Systems can be found on the wiki here.

- + +

+ Running AssaultCube +

+ + + + + + + + + + + + + +
+ + + Windows
+ Use the shortcut provided. Or execute the AssaultCube.bat file in your AssaultCube folder. +
+ + + Linux
+ In a console, change your location (cd) to the main AssaultCube directory and then execute AssaultCube.sh. +
+ + + Mac OS X
+ Open the applications folder. Click on AssaultCube. Select the options you want to use to run AssaultCube and then press play. +
+ +

Special notes

+

+ Users of Windows Vista:
+ Make sure you have full permissions to the AssaultCube folder so that your files + (such as configs, screenshots and maps) may write there. To do this right-click the AssaultCube folder and then + click properties. Click the security tab. Find your user name in the list under Groups or user + names and click on it. Press edit and check the Full control box. You will need to press OK on the UAC also. +

+

+ Users of Linux:
+ Note: Files that AssaultCube writes during the game (such as screenshots, configs and + maps) get saved in the hidden .assaultcube folder in your users home directory. +

+

Display settings

@@ -127,40 +201,10 @@ different parameters can be found in command-line arguments. You can also add commands to config/autoexec.cfg so they automatically execute on startup.

-

- Running AssaultCube -

+

- - Windows
- Use the shortcut provided. Or execute the AssaultCube.bat file in your AssaultCube folder. + Note: Thanks to Harps for explaining the permissions of Windows Vista and KanslozeClown for explaining the process for using AC on Mac OS X.

-

- - Linux
- In a console, change your location (cd) to the main AssaultCube directory and then execute AssaultCube.sh. -

-

- - Mac OS X
- Open the applications folder. Click on AssaultCube. Select the options you want to use to run AssaultCube and then press play. -

- -

Special notes

-

- Users of Windows Vista:
- Make sure you have full permissions to the AssaultCube folder so that your files - (such as configs, screenshots and maps) may write there. To do this right-click the AssaultCube folder and then - click properties. Click the security tab. Find your user name in the list under Groups or user - names and click on it. Press edit and check the Full control box. You will need to press OK on the UAC also. -

-

- Users of Linux:
- Note: Files that AssaultCube writes during the game (such as screenshots, configs and - maps) get saved in the hidden .assaultcube folder in your users home directory. -

- -

Note: Thanks to Harps for explaining the permissions of Windows Vista and KanslozeClown for explaining the process for using AC on Mac OS X.