AFKAlarm

From ISMods Wiki

1 Introduction
2 Features
3 Requirements
4 Installation
5 Starting AFKAlarm
6 Using AFKAlarm
7 Configuration
8 Version History

Introduction

AFKAlarm is a script written and maintained by BobTest, with the UI implemented by Jackalo.

It's sole purpose is to monitor whichever chat channels you choose and sound an audible alert whenever one is detected, as well as echo the message into the console for easy viewing at a later time.

[edit]

Features

Multiple channel support
Sounds an audible sound whenever chat is detected
Has it's own console window where you can easily see all messages from the monitored channels
Can log the console window to a file for archival purposes

[edit]

Requirements

AFKAlarm uses features from the ISXWoW extension.

[edit]

Installation

Download the latest AFKAlarm zip file from here (usually the last post in the thread) and extract the contents into your InnerSpace Scripts directory (usually C:\Program Files\InnerSpace\Scripts). You should see the following directory structure...

InnerSpace
+- Scripts
   +- AFKAlarm.iss
   +- AFKAlarm
      +- Data
      +- Docs
      +- Include
      +- Interface

[edit]

Starting AFKAlarm

To begin using AFKAlarm, type the follow command into the Console...

RunScript AFKAlarm

[edit]

Using AFKAlarm

AFKAlarm has a new user interface as of version 1.6.0 that is based on LGUI Tabs to organize information in a better way.

This is the main AFKAlarm window.

It displays all the currently supported chat channels, and a count of how many messages have been received on each one since they were activated. If you are not monitoring a channel, then it simply states OFF so as to avoid confusion. The yellow timer near the top shows how long AFKAlarm has been running.

[edit]

Configuration

[edit]

Channels Tab

This is the Configuration Tab for AFKAlarm.

Here you will find all the toggles for which channels AFKAlarm is currently monitoring. If you see a red filled-in circle in the box, it means that AFKAlarm is monitoring that channel. If you see an empty square (just a white square with no filling), it means that AFKAlarm is not currently monitoring that channel.

[edit]

Options Tab

Display Console will display the AFKAlarm Console. AFKAlarm echoes all text from a monitored channel into the console, along with a timestamp so you know when it happened.

Log to File will log everything in the AFKAlarm Console to a text file in your AFKAlarm/Data/Server/Character/Logs directory. It should be noted that it will not start logging anything until this is checked, so any console output that happened prior to enabling this feature will not be logged.

[edit]

About Tab

This is the About Tab for AFKAlarm.

It's sole purpose is to inform the user of the version number, but also is a nice place to show the author's name and to let the author thank whoever he chooses.

[edit]