= Welcome to shaim =


== Installation ==

The latest official release is [http://shaim.net/trac/trac.fcgi/shaim/wiki/0.4%20Release version 0.4].

To get the bleeding-edge version, [wiki:NightlyBuilds download the latest nightly build] and unzip it.  ''May be unstable.''

To get the source code, download it from our Subversion repository at svn://shaim.net:41120/shaim/trunk

=== Prerequisites ===

shaim requires the [http://www.microsoft.com/downloads/details.aspx?FamilyID=10CC340B-F857-4A14-83F5-25634C3BF043&displaylang=en .NET 3.0 Framework], which can be installed on '''Windows XP SP2''', '''Windows 2003 Server SP1''', and later versions of these operating systems.  '''Windows Vista''' and higher do not require any additional installations.

== Using shaim ==

 * [wiki:Screenshots]
 * [wiki:UsingGtalk Using shaim with Google Talk]

=== System Configuration ===

shaim configuration is usually done via the UI, which provides a rich interface for configuration shaim's system settings as well as those of the plugins.  When using the shaim framework in a headless mode, configuration is performed via the command line and direct editing of the preferences file.

 * [wiki:CommandLineOptions Command Line Options] - Available options to pass to shaim.exe or shaimService.exe via the command line
 * [wiki:PreferencesXmlFile Preferences XML File] - The schema and layout of the shaim.xml preferences file

== Plugins ==

The shaim framework consists of the shaim core, which provides a central point of control for a set of ''plugins.''  There are three classes of plugin:
 * [wiki:FunctionalityPlugins Functionality plugins]
 * [wiki:NetworkPlugins Network plugins]
 * UI plugins

== Developers ==
 * [wiki:Developers/ shaim developer reference]

== Contact us ==

You can talk the shaim-dev team in [irc://irc.freenode.net/shaim #shaim at irc.freenode.net], or post a thread on the [http://csammisrun.net/shaim/ shaim forums].