Read Me

A3DX README

LICENSE
=======
A3DX source code, any release.

Copyright (c) 2007-2008 A3DX dev team.

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.

LICENSE NOTES
=============
Game media included in the game (textures, models etc.)
are NOT covered by this license, and may have individual copyrights and
distribution restrictions (see individual readmes).

Required librairies:
SDL, SDL_image, OpenGL.


COMPILING
=========
In order to compile A3DX, you need the dev librairies.

Linux:
To compile, use the make command
$ make
It will compile and install everything : server, ai, client and the config tool.
You need the dev librairies for compiling :
-libsdlX.X-dev (where X.X is the version number of your libsdl installation)
-libsdl-imageX.X-dev
-libgl1-mesa-dev (OpenGl dev lib)

Mac OS X:
To compile everything, run the script makeosx.sh.
To compile the server and the ai, use the Makefile.
To compile the client and the launcher, there are .xcodeproj files provided in Main_Config and Main_Client.
You need to have SDL.framework, SDL_image.framework and SDL_mixer installed in your Library/Framework folder. You can get them at www.libsdl.org. They are also included in the A3DXClient bundle (right-click on A3DXClient.app -> "Show package contents" then go to Contents/Frameworks).

After compiling, if the install.sh script was run, there should be a new directory named "build". Here is its content:
Linux:
build/server/A3DXServer
build/server/A3DXAI
build/server/data
build/client/A3DXClient
build/client/A3DXConfig
build/client/data

Mac OS X:
build/server/A3DXServer
build/server/A3DXAI
build/server/data
build/client/A3DXClient.app
build/client/A3DXConfig.app

RUNNING THE APPLICATION
=======================

You need to have a running server, it can be a local one, or a distant one.

If you host the game or for a local game, start the A3DXServer.
Launch the A3DXConfig and input the correct information, username and server IP (127.0.0.1 in case of local game).

"Save" will write the information in a config file so next time this information will be loaded.

Push on the play button and enjoy :)

IN-GAME CONTROLS
================
The camera controls are configurable using the config tool (or by directly writing them in data/client.ini).
The other controls are:
F1-F4: select a cannon if there is a cannon at that position or deselect the currently selected cannon.
F5: deselect the currently selected cannon.
alt-m: minimize the current window.
alt-t: focus on the chat.
ESC: quit window focus.
ctrl-q on Linux or apple-q on Mac OS X: quits the application.

Read the pdf readme for more information about the game.