README

 Sear
-====-

Sear is a 3-D client for use with the WorldForge project. It requires a 3-D accelerated graphics card supporting Open GL. Sear aims to be able to only relatively low power hardware. 

Please visit website for full instructions. 

Website: http://www.worldforge.org/dev/eng/clients/sear

Please report bugs on the Sear forum at http://forums.worldforgedev.org/

Simon Goodall

Email: sear@simongoodall.co.uk
IRC: irc.worldforge.org NICK simon

Windows Information
-------------------

Run sear.bat to check for updates to Sear itself (nighly build versions) and then look for media updates. Sear-bin.exe can be run directly to avoid launching the updater.
If "SYS_DRIVE:\Documents and Settings\username\Application Data\Sear" is available (e.g. Win 2K and above) then Sear will download media updates and local coniguation files in this directory. If this directory does not exist (e.g. Win 98) then updates and local configuation files will be stored in the current working directory.
Sear does *not* require administrator privileges to install or run. Administrator privileges may be required during installation if installing into Program Files.

Linux Information
-----------------
On Linux systems, a shell script called "sear" is used in fire the updater for Sear itself (nightly build versions only) and for media updates. The binary sear-bin can be run directly to avoid running the updater.
Local configuration files and updates will be stored in $HOME/.sear

Known Issues
------------

** On Ubuntu systems, Sear can fail to start due to the following error:

Creating link /home/sg/.kde/socket-echo.
can't create mcop directory.

  This can be worked around by setting the SDL_AUDIODRIVER environment variable
  before starting Sear. E.g.

  $> SDL_AUDIODRIVER=alsa /opt/worldforge/bin/sear


** Many Invalid Enum error messages

On systems with NV_point_sprite but not ARB_point_sprite, Mesa 7.2 has a bug where a call to glPointParameterf(GL_POINT_SPRITE_COORD_ORIGIN, ??) can cause GL_INVALID_ENUM to be thrown. Sear itself does not make this call, however Guichan indirectly calls this function.

Solution: Upgrade Mesa. 

** Gui breaks on character type selection.

This is a guichan bug which has been fixed in the current development version. 
Current work around is to presss tab to move keyboard focus to the dropdown and then use the up/down cursor to select a character type.


Dependencies
------------

Atlas: 0.6.0
Eris: 1.3.13
Varconf: 0.6.4
WFmath: 0.3.2
Skstream2: 0.3.1
Mercator: 0.2.4
LibModelFile: 0.1.92
Sage: 0.2.0
libwfut: 0.2.1

http://sourceforge.net/projects/worldforge

SDL 1.2.2 
http://www.libsdl.org/

SDL_image 1.2.1
http://www.libsdl.org/projects/SDL_image

SDL_mixer 1.2.4
http://www.libsdl.org/projects/SDL_mixer/

libsigc++ 2.0.x (not 2.0.8)
http://sourceforge.net/projects/libsigc/

Lib3ds 1.2.0
http://sourceforge.net/projects/lib3ds/

OpenGL 1.3 or greater

Cal3D 0.10.0
http://sourceforge.net/projects/cal3d/

Guichan 0.8.2
http://guichan.sourceforge.net/


Sky Dome based on;
http://www.geocities.com/ngdash/whitepapers/skydomecolor.html