Quick-Start

Simply type a message into your chat box and hit enter. Messages can contain pre-defined aliases, which will be replaced by the text they represent. Aliases work when used from within macros, too!

Type /listaliases, or open the aliases.lua file in any text editor to see a complete list of aliases.

Examples

> /me looks at a little $targetgender named $target and laughs in $possessive face.
>>> Jooky looks at a little male named Bill and laughs in his face.

> Hello! My name is $name! I'm a level $level $race $class. It's nice to meet you!
>>> Hello! My name is Jooky! I'm a level 26 Tauren Hunter. It's nice to meet you!

Basic Slash-Commands/chatalias help - displays this help message

/listaliases - displays a complete list of aliases

/fileonly

on - Turns on auto-loading of aliases.lua file. In-game editing of aliases will be disabled. Warning: this will overwrite your in-game aliases!

off - Turns off auto-loading of aliases.lua file. In-game editing of aliases will be enabled.USING ALIASES

Alias-editing commands

NOTE: In order to use these commands, you must first turn off auto-loading of the aliases.lua file. To do that, type '/fileonly off'./addalias <$name> - adds a static alias to your in-game list of aliases.

/delalias <$name> - deletes the named alias from your in-game list

/adddyn <$name> - adds a dynamic alias to your in-game list. must contain valid Lua code.

/deldyn <$name> - deletes the named dynamic alias from your in-game list.

/loadaliases - overwrites your in-game alias list with the aliases.lua file.

Aliases are 'shortcuts' that get replaced by long phrases or values. An example would be the alias '$pst'. When you use $pst in a message, it will be replaced by the phrase 'Please send tell.' Aliases may start with the dollar sign($), the percent sign(%) or nothing at all. Be careful which words you choose as aliases, since they will always be replaced by their associated text. An example of an alias that starts with no sign is the 'teh' alias. The word 'teh' will always be replaced by 'the'.

Aliases are defined in the 'aliases.lua' file. This file contains a bunch of aliases that I thought might be useful. You can use the provided aliases, or you can define your own. Aliases can reference other aliases, so be sure that you don't have two aliases that point to each other, or you will end up in an infinite loop and hang the game.

There are two kinds of aliases: static and dynamic.

Static Aliases

Static aliases are always the same. The '$pst' alias is an example of a static alias. It will always be replaced by the phrase, 'Please send tell.' Static aliases can appear to change if you reference dynamic aliases (see below) in their definitions. Defining your own static aliases is quite simple, as you will see when you open the 'aliases.lua' file in any text editor.

Examples of Static Aliases:

> /addalias $grats Congratulations on your new level!
> /say $grats
>>> Congratulations on your new level!
> /addalias $lfg Level $level $race $class looking for group! $pst
> /say $lfg
>>> Level 26 Tauren Hunter looking for group! Please send tell.

Dynamic Aliases (Advanced users only)

Dynamic aliases get their values from Lua code, and can therefore change depending on circumstances. An example would be the alias '$health'. This alias will be replaced by your current health and may give a different value every time you use it. Defining your own dynamic aliases is a little more difficult than defining static aliases, unless you have some knowledge of Lua and the WoW API.

If you want to use logic (for..do, if..then, etc) in a dynamic alias, then you must do it within a function. Your function should return a text string, a number, or nil.

Exampes of Dynamic Aliases:

/adddyn $target UnitName('target')
/adddyn $targetsex function() if (UnitSex('target')==0) then return 'male'; elseif (UnitSex('target')==1) then return 'female'; end end
/adddyn $possessive function() if('$targetsex' == 'male') then return 'his'; elseif ('$targetsex' == 'female') then return 'her'; end end
Note that the $possessive alias uses the $targetsex alias as a variable inside the function. This opens the doors to some pretty powerful aliases, if you know what you're doing.

Using Repeat

Repeat will repeatedly send a message after a given interval of time. The minimum interval of time is 3 minutes to prevent spamming. Also, the maximum number of repeats is 30 to prevent all-night AFK spamming.

Repeat commands:/repeat

help - displays this help message

msg - sets the repeating message to

time - the number of seconds between sends (Minimum is 180)

chan - sets the channel the message will be sent to
-->(Examples: say, yell, raid, party, guild, 1, 2, 3, etc.)

chan whisper - sets the channel to whisper and the target to

start - starts repeatedly sending the message

stop - stops repeatedly sending the message

status - displays current settingsExample

/repeat msg Level $level $race $class looking for group!
/repeat chan 1
/repeat start
Sends this every 3 minutes: 'Level 26 Tauren Hunter looking for group!'

Using Countdown

Countdown sends a message after a certain amount of time has passed. It will optionally count aloud for the last 10 seconds (Only for channels: say, guild, party, raid).

Countdown commands:/countdown

help - displays this help message

msg - sets the message that will be displayed when the countdown is complete. Leave empty for no message.

time - sets the number of seconds to wait before sending the message

chan - sets the channel the message will be sent to

chan whisper - sets the channel to whisper and the target to

showcount on - counts aloud for the last 10 seconds. Only for the following channels: say, guild, party, raid

showcount off - turns off counting aloud

start - starts the countdown

stop - cancels the countdown

status - displays current settingsExample

/countdown msg Fire!
/countdown time 5
/countdown showcount on
/countdown start
Sends this to the party channel:
5
4
3
2
1
Fire!

Report this mod