@database AmIRSay.guide
@author "Bruce Steers <bsteers\@btinternet.com>"
@font topaz.font 8
@wordwrap
@node main "AmIRSay Written by Bruce Steers"
Short: Speak AmIRC incomming text with many Options
Author: Bruce steers <bsteers\@btinternet.com>
Uploader: http://www.btinternet.com/~bsteers/
Version: 4.0 (04/04/00)
How to Register @{" FREE Registration " LINK reg}
What is Needed ? @{" Requirements " LINK req}
What does it do ? @{" Features " LINK feat}
How do i use it ? @{" Usage " LINK usag}
Usefull Aliases @{" ALIAS " link alias}
How to Install @{" Installation " LINK inst}
Program Developement @{" History " LINK hist}
any problems please email me at bsteers\@btinternet.com
or find me (Nickname 'Brucey') on the following irc channels
irc.stealth.net/6667 channel #Amigazone
irc.u-net.com/6669 channel #Amigazone
uk1.arcnet.vapor.com/6667 Channel #Amiga
get future updates at http://www.btinternet.com/~bsteers/prog/
()_\\
() /
Brucey
@ENDNODE
@NODE req "What is Needed ?"
Requirements
For Accents to work you MUST get the following archives from Aminet..
util/libs/translator42.lha <mbarlow\@pacific.telebyte.net>
util/libs/Tran43pch.lha Francesco Devitt <ffranc\@comp.vuw.ac.nz>
util/sys/SayV43.lha Peter Kaltstein <CyberStrike\@studbox.uni-stuttgart.de>
Installation/Upgrading to these is Simple :)
you just put Say in sys:utilities (or something)
then use the translator42.lha Install Script to install translator.library
then use the Tran43pch.lha Installer Script to update translator.library
OTHERWISE you will have to use the 'Say' Package that comes with WB2.x Disks
ABSOLUTELY REQUIRED files are ..
--------------------------------
narrator.device (only available on Amiga OS2.x Disks)
translator.library (on OS.2x Disks or newer versions on Aminet)
@ENDNODE
@NODE feat "AmIRSay Features"
Features..
o typed word/s can be spoken as other words , like 'oic' as 'oh i see'
single words can be omited or any occurence of some text.
o letters/words/sentences can be blanked (unspoken), like '<' '*' 'f++k'
it also blanks PrivMsg types like PING and a CTCP VERSION
o Friends (and enemies) can be given alternative voice styles or can
be made silent with the 'No Voice' setting.
o Set a default voice for any nicknames not specified (can be 'No Voice')
all 'say' parameters can be ajusted by the gui.
o Supports Translator43.library with Accents.
o Sentences spoken can be prefixed with users nickname.
o Double Starting in an AmIRC port can be set to either alert you
that it's already running or it can load the prefs.
o has a menu item for checking and for getting any newer
version that may be available.
More features may be added in the future
Watch this space :^)
@ENDNODE
@NODE usag "Using AmIRSay"
Using AmIRSay
-------------
AmIRSay comes in 2 main parts.
The First is the AmIRSay.amirx ARexx Script that goes in AmIRC/Rexx.
this script waits for text and then uses Amigas 'Say' command to
speak incomming text.
The Second is the AmIRSayPrefs mui app that goes in the AmIRC progdir.
this is a nice gui for altering the configuration of AmIRSay
both utilities have their own Arexx ports with their own commands
When using the AmIRSay_Install Script you can add a few @{" ALIAS " link alias} commands
to AmIRC .
@ENDNODE
@NODE says "Starting AmIRSay"
You can Start AmIRSay in many ways...
in a channel type /rx amirsay ..
or select the AmIRC Arexx menu 'AmIRSay.amirx'
or if you installed the aliases then type /says
1 argument can be parsed -a<bool> . this is to override the setting for
letting all the channel users yu have started AmIRSay.
i use it if i have a newer version than than my friends as it normaly
only outputs the text to me and i don't want to have to redo the settings
eg..
/says -a0 ; this will output to only you no matter what your settings
/says -a1 ; this will output to the channel no matter what your settings
@ENDNODE
@NODE sayv "Getting the version number"
You can Get the version string of AmIRSay in these ways...
in a channel type /rx amirsay sayv ..
or if you installed the aliases then type /sayv
@ENDNODE
@NODE sayn "Check and download new version"
You can Check for new versions online and download them ...
in a channel type /rx amirsay sayn ..
or if you installed the aliases then type /sayn
For this to work you must be online and have valid TCP: access
Programs like nc2 , AmiTCP, Miami, Genesis should be ok
@ENDNODE
@NODE sayg "load the Prefs GUI"
You can Start AmIRSayPrefs in many ways...
In a channel type /rx amirsay sayg ..
or if you installed the aliases then type /sayg
If AmIRSay.amirx is already running in your AmIRC port
then you can either..
get a message saying it's already running
or make it load AmIRSayPrefs
@ENDNODE
@NODE sayu "Updating Settings"
this is pretty obsolete now as the prefs program will apply this
command when you save the settings.
i kept it in for people who might edit their settings
by hand and need a way to reload.
this command (and a couple of others) will ping to the server before running.
the reason for this is that the AmIRSay.amirx script is locked while waiting
for someone to say something. A ping will cause the lock to be freed.
@ENDNODE
@NODE sayq "Quitting"
@ENDNODE
@NODE say# "Ignoring Channels"
This will toggle on/off speaking in a given channel.
Syntax: SAY# <Channel> if channel is not given the current channel is used
examples..
/say# ; Silence/Hear current channel
/say# peecee ; Toggle #peecee channel
to set permanently use the Prefs program
@ENDNODE
@NODE say? "Calling Help"
@ENDNODE
@NODE alias "Aliases added by Install_AmIRSay"
Using the Install script has a function to add some handy alases to amirc
Don't wory if yu already have them because they will all be updated
All alias commands are typed in an AmIRC channel window...
Selecting Yes to adding these aliases gives the following commands
/SAYS = @{" Start AmIRSay " link says} ; Starts the script and monitors channels
/SAYV = @{" Get AmIRSay Version " link sayv} ; gives ou the version of your AmIRSay
/SAYN = @{" Check for New Version " link sayn} ; Downloads newer version (if any)
/SAYG = @{" load GUI " link sayg} ; starts the prefs program (or activates it)
/SAYU = @{" Update Preferences " link sayu} ; reloads settings if edited by hand
/SAYQ = @{" QUIT AmIRSay " link sayq} ; Exits the ARexx script
/SAY# = @{" Ignoring Channels " link say#} ; Turn Speaking off in a channel
/SAY? = @{" Call Help " link say?} ; Lists these commands.
@ENDNODE
@NODE inst "How to install"
installation
Manual:
AmIRSay.amirx must be in AmIRC/Rexx/ dir
AmIRSayPrefs must be in AmIRC/ dir
AmIRSay.guide can be in AmIRC/ or HELP: or HELP:English/
Running the install script:
Double click the Install icon
if AmIRC is running quit and restart to activate the menuitem or type
@{b}@{u}/rx amirsay@{uu}@{ub} in the channel window
to test say just use WB menu 'Execute Command' and enter
say something
if you hear the word something spoken you are ok . if not
check you have the translator.library in libs: and the
narrator.device in devs: and say in sys:utilities or something
@ENDNODE
@NODE hist "Program History"
The History of AmIRSay from version 4.0
-----------
4.0
Added List in gui to ignore text (switch off speaking) to any named channel..
Added command 'SAY#' to AmIRSay.amirx for Silencing Channels
fixed some bugs in the new list handling methods (sorting)..
Started this History Page..
-----------
3.9
Fixed the 'Get New Version' function.
Redid the way the lists worked so updating is cleaner.
Gave every list String gadgets to save opening up the edit window when
double clicking a item , now clicking will speak text / voice styles
-----------
up to version 3.9 there were many changes . history has not been kept but
basicaly it grew and grew :^)
@ENDNODE
@NODE reg "FREE Registration"
Registration for AmIRSay is FREE
The only reason for registration is so i can get some idea
of how many people use amirsay enough to register it.
restrictions in unregistered version...
---------------------------------------
When you quit the Prefs program you get a delayed notice that you are
not registered and it beeps :)
How to register.
----------------
send an email to..
bsteers\@btinternet.com
with the subject 'reg-amirsay'
in the body please give your first and last name, ie. Bruce Steers
and add any comments / suggestions you want.
@ENDNODE