			AniClient basic how-to-use
			--------------------------


This document assumes you know how to use regular Hotline.
(it may be kind of outdated, i'll update it next time i have time ^_^)


CONTENTS OF THIS DOCUMENT :
1) Quick start
2) Description of all options & features


--------------
1) Quick start
--------------

Easy enough :

a) Launch the application
b) If it is the first time, it will ask for the location of the hotline.dat file u wish to use. Browse to it and accept.
c) Click the 'User Options' in the main window (3rd button of bottom line)
d) Enter ur user name, click the icon, select the one u want to use in the icon list, validate
e) Click the 'Quick Connect' button (1st one, top row)
f) Fill in server ip, the port if it isn't 5500, login & password if u wish to use one
g) Click the 'connect' button, it should connect to specified server

That's all for that section !
Now let's move to a full description of options....


----------------------------------------
2) Description of all options & features
----------------------------------------

I'll describe window by window, starting with the main window

A) The main window
------------------

It comports the following elements, from left to right, up to bottom :
 * first line
  * quick connect button
  * trackers window button
  * bookmarks window button
  * bookmarks list
  * connect to bookmark button
  * auto-connect toggle button
  * exit button
 * second line
  * global AniCONS options
  * default server options
  * default user options
  * quick status list
  * help button (non-functional for now)

Let's explain the different buttons...

a) Quick Connect
- - - - - - - -
This button opens the 'quick connect' dialog, which lets u (u guessed it) quickly connect to a server.
Fill in ip, port, login & password if they are required.
Click 'connect' to connect to the server, or 'cancel' to cancel

b) Trackers window button
- - - - - - - - - - - - -
This button will display the 'trackers' window. Please see the following sections for more info on that window.

c) Bookmarks window button
- - - - - - - - - - - - -
This button will display the 'bookmarks' window. Please see the following sections for more info on that window.

d) Bookmarks list & Connect to bookmark button
- - - - - - - - - - - - - - - - - - - - - - -
All bookmarks are listed here. 
To connect to a bookmarked server, select it in the list & click the 'Connect' button next to the list.

e) Auto-connect toggle button
- - - - - - - - - - - - - - -
If this button is pressed, the next time u launch the application it will automatically connect to bookmarks having the 'auto-connect' property.
Check the section related to bookmarks for info on how to set this property.

f) Exit button
- - - - - - -
Exits AniClient & closes all server windows.

g) Global AniCONS icons
- - - - - - - - - - - -
For now, only lets you choose the font to be user in chat window.
Note that changes made to the font are only for new server windows, currently opened windows will keep their current font.

h) Default server options
- - - - - - - - - - - - -
Here you define the server options new bookmarks will have.
See the section on server options for more info.

i) Default user options
- - - - - - - - - - - -
Here you define your user name & icon, and also different predefined status.
New bookmarks will have those settings.
See the section on user options for more info.

j) Quick status list
- - - - - - - - - -
All predefined user status are listed here.
Change current status to change your name / icon on all servers you are connected to.
See the section on user options for more info.


B) The tracker window
---------------------
This window lets u list trackers & get servers lists from them.
Top list is the trackers u wish to list, bottom list are the servers on those trackers.

You can add, modify & delete trackers using the top buttons.

The 'refresh' button will connect to selected tracker & list servers.
The 'stop' button will stop listing of currently selected tracker.

The 'refresh all' and 'stop all' buttons will do as above on all trackers.

The bottom list contains servers, 3 columns, name, users currently online & description.
From this list u can connect to a server or bookmark it.

To search for a specified string, enter it in the edit line between 'search' & 'clear' buttons, and click 'search'.

You can also totally clear the list by clicking the 'Clear' button.


C) The bookmarks window
-----------------------
Here you will define bookmarks.
Each bookmark has the following properties :
 * server name, which will appear as the caption of the server window when you are connected to it
 * ip
 * port
 * login (defaults to 'guest')
 * password (defaults to null)
 * auto-connect: if set, and if the 'auto-connect' button is checked in the main window, each time you launch the application it will connect to that bookmarked server
 * icon to use in the task bar for the server window


D) The server options dialog
----------------------------
This dialog box lets you define the following options :
 * sound to be played when a private message or chat message is received
 * display user entering / leaving the server, with or without your local time
 * kick & ban options : useful to avoid kicking inadvertently someone. Kick & ban can be changed to 'disabled, 'confirm', 'no confirm' [should be pretty explicit]. Note that u can't set ban to 'no confirm' if kick is not set to 'no confirm'


E) The user options dialog
--------------------------
Here you will define your nickname & ur icon, and also different predefined status.
It should be obvious how to change your user name.
Click the 'icon' button to change your icon.
You can use the 'look as' drop list to check how your nickname / icon will appear in different circumstances (when u admin, regular user, and so on)


What is a predefined (user) status ?
- - - - - - - - - - - - - - - - - -
It's a simple way to change your name / icon when you want to inform other users of your status.
Status work globally, meaning that when you change the selected status in the main AniClient window, you change your name and/or icon on _all_ servers you are connected to.
This is useful when you are connected to many servers and yet wish to inform others of what you are doing.

One status consists of 3 things :
 * a name
 * a nickname
 * an icon

The name will appear in the 'quick status' list on the main window. It is used as a reminder of what the status is meaning.
Nickname & icon will be the ones used when the status is selected.

Example:
 * status called 'normal', nickname 'Lazy user', icon 24000
 * status called 'ZzZz', nickname 'Lazy user [ZzZz]', icon 24001
 * status called 'away', nickname 'Lazy user [out]', 'icon 24002

Switching between those 3 status will change your nickname / icon accordingly.


How to add a status
- - - - - - - - - -
Note : you can add a status only from the 'user options' dialog accessed from the main AniClient window.

Enter your nickname, choose your icon, then click the 'add' button & enter the status' name. That's it !


How to modify a status
- - - - - - - - - - -
Select the status you wish to modify in the 'status' drop list, change nickname and/or icon, click the modify button.



F) Note on user options & server options
----------------------------------------
Each bookmark has it own user options & server options.
This means you can, on server A, choose to display users entering / leaving the chat, but not on server B.
Also, you can change user options for server A so that all status have the nickname 'Lazy user' and icon 24000.
This let you have different identities on different servers without having to change nickname / icon all the time ;p

Note : for now, you can only change user / server options of a bookmark from the server window of that bookmark, meaning you need to be connected to the server.



G) Server window
----------------
Each server you are connected to will have its own window.

On left or top you have a column/row of buttons, mainly :
 * disconnect from server
 * user options for that server
 * server options for that server
 * news
 * files
 * account modification / creation


One window will have different subwindows, some will be described here (you should be able to figure out how the others work).
Those subwindows appear in a tab control on top of the window.


a) Chat window
- - - - - - -
This is either the public chat or a private chat.
Public chat is always the first tab.
To send text, select the bottom zone, enter your text & press enter (regular text) or control-enter (emote)

The following buttons are available :
 * clear chat
 * show / hide user list
 * private message to selected user
 * private chat with selected user. If you are currently in one or more private chat, the list of those chats will appear to let the user join it, or you can choose to create a new private chat.
 * get user info on selected user
 * kick / ban (when used with 'control' pressed) selected user. Note that depending on the server options, kick or ban may be ignored.
Ths following are available for private chat only:
 * exit private chat
 * change chat subject


b) Task window
- - - - - - -
On top are active tasks, on bottom queued tasks.

'Active' means either currently transferring or waiting in server queue for a spot.
'Queued' means _locally_ queued.
By default (and it is not customizable for now) AniClient will enable one download & one upload simultaneously only. Other tasks will be locally queued while the current one completes.

Note : for now, tasks queued on server _are not_ displayed in the task list...
this mean that is you try to download a file & it appears as queued, it means you have a download remotely queued on the server...

The 3 'cancel' buttons let you cancel an active, queued or all queued tasks.


c) News window (for news >1.5)
- - - - - - - - - - - - - - -
Left list displays news categories & groups.
Right top list displays articles for selected category.
Right bottom field shows current selected article.

The following buttons are available :
 * refresh category or group (no way to refresh news root for now)
 * close news window
 * reply to selected post
 * start a new thread
 * mark all articles as 'read' or 'non-read'


d) File window
- - - - - - -
Top list is the remote filesystem, bottom is the local one.
Double-click a folder to see its contents.
To go up (either remotely or locally) in directories hierarchy, click the directory path & select destination in the menu.
[example: remote directory is '/uploads/slot 1', the menu will display '/uploads' & '<root>']

To download a file:
 * browse remotely to it in the top list
 * select a local directory in the bottom list
 * double-click the file or select & click the 'download' button

To upload a file:
 * browse locally to it
 * select remote directory in which to upload
 * double-click the file in the bottom list

To download all files in a directory:
 ***note : this is non-recursive, meaning you will download the files in the directory but not the ones in its subdirectories
 ***note2: this is equivalent to download one file at a time manually, it's just easier
 * double-click the directory you want to leech
 * go up one level
 * select the local directory where to leech
 * click the 'download' button
 ***note3: don't worry if the window freezes for a few, especially if u asked to leech 200 files !

The following buttons are available for remote files (top row):
 * refresh dir contents
 * download file / folders content
 * make a new dir
 * rename a file / folder
 * move file / folder
 * trash

Note: the 'download', 'move' and 'trash' buttons work on all selected files / folders in the list. Other buttons only work when one file / folder is selected.

For local files, the only button is 'refresh'



I'll let you guess how to use other server subwindows, it shouldn't be too hard...
