ChatMOD README



How to Install ?

Extract the content of the ZIP File to you World of Warcraft Addon directory.
e.g.:"C:\GAMES\World of Warcraft\Interface\AddOns\"
Make sure to extract this files into a directory called "ChatMOD" else it wouldn't work.



How to use ?

Just type /chatmod in game and use the GUI or /chatmod ? for command line options.
There are some additional Commands which can be used. In general each GUI Command
is also available by commandline but not every commandline option is toggleable by the UI.

To keep this short I only write down the commands which are not accessible by the GUI.
Each command have to be passed to Chatmod as paramenter /chatmod <parameter> for
example to pass the timestamp command to Chatmod you have to type in /chatmod timestamp


/chatmod timestamp   

This command alow to customize the timestamp. It is neccessary to provide a
2nd parameter which is interpreted as the Timestamp. If you leave this 2nd par.
empty the timestamp is disabled. Example: /chatmod timestamp help
this help will popup a screen with some hints how to configure the timestamp.
Example:    /chatmod timestamp #FF0000$h:$m
Result:        10:23

Available Format Strings are:

$h

Hour in 24h format

$t

Hour in 12h format

$m

Minute

$s

Second

$p

AM / PM

#XXXXXX

Html Color Code


Timestamps can be disabled by entering: /chatmod timestamp

/chatmod clear     or     cls

This commands clear every visible chatframe.

/chatmod initchan <channelname>

Since 1.11 wow set the last joined channel as default channel for startup. With this command
you can set any channel as default channel. The specified <channelname> will be initialized at
the loading process. Tip: Casesensitive!

ChatSound Feature

Since 1.05 beta 3 it is possible to setup own mp3 files as sound notification event sounds. You can do this
by replacing the 5 existing mp3 in the subfolder /audio/ in the Addons/ChatMOD/ Directory. This can be
normal mp3s of your choice. You can setup them later in the game by entering the ChatSound menue in the
ChatMOD GUI by typing /chatmod

The chatframe Scrolldown Button

After requested by several users ChatMOD  now adds a button to the chatframe which is only visible if you
have scrolled up in the window. If you click this button you automaticaly going down. Time to time on some
Clients the button is set to the middle of the screen. But this is not a huge problem you can move the button
individualy like you wish. Simple hold down the <CTRL> Key and drag the button to the Postition you want.
After you stop draging and klick on the button this position is saved and will be restored each time your
UI loads. This is save per Charackter .

Mousewheel Chatscrolling

With Chatmod you are able to use your Mousewheel to scoll the Chatwindow:

MOUSE-WHEEL-UP:             1 line up
MOUSE-WHEEL-DOWN:     1 line down
<SHIFT>    MOUSE-WHEEL-UP:     3 lines up
<SHIFT>    MOUSE-WHEEL-DOWN:     3 lines down
<CTRL>    MOUSE-WHEEL-UP:     Jump to top
<CTRL>    MOUSE-WHEEL-DOWN:     Jump to Bottom



Found a Bug or have a Feature Request ?

If you found a Bug or have a Featurerequest please use the provided Form on my Website to Submit this.
You don't have to register, you can submit Bugs / Requests Anonymous if you want to. Please use this Form
because for me it is hard to recheck every Addonwebsite day by day and browsing the comments, writing down,
checking and finaly do the work. Because this Addon is, like all other WoW Addons too, developed in the
sparetime of a hobby programmer I don't want to stick in support and concentrate on the actual thing.

Donate ?

If you would donate $1 to whatever, please feel free to do so ;) 

       






CHANGE LOG
You can find a detailed Changelog in the WebSVN

1.05b

  • Added full ChatLink Compatibility. You are now able to link Items in every Chat.

  • Fixed bug #143 - Itemlink

1.05

  • Fixed bug #53 - Sticky Chat improvements

  • Fixed bug #58 - Old Zone optimizations removed

  • Fixed bug #48 - GossipSkip fix for BWL NPC

  • Fixed bug #54 - Veyska class colors

  • Fixed bug #46 - More Keybindings /1 /2 /3 ...

  • Fixed bug #57 - fix for Apostrophes in URL's

  • Testing Code for Sync capability inserted

  • Feature Req. #64 - Ability to define the default chatframe on startup. Type /chatmod initchan General to set General as initial chattab. *still buggy*

  • Fixed bug #65 - Gossip Talk to NPC's fix

  • Fixed 1,05 beta 1 sync bug where General is on 2 instead of 1

  • Fixed bug #63 - Bliz. default sitcky behavior 

  • Fixed bug #61 - highlight bug

  • Changed used Fonts to system wildcards to prevent Chineese / Korean client problems

  • New Command /clear or /cls clear all visible chatboxes

  • Feature Req. #28 - Added Scroll down button

  • Fixed bug #74 - Only process CHAT_MSG

  • Fixed bug #73 - /chatmod initchan cutoff first letter

  • General Tidyup in function S_AddMessage

  • Feature Req. #59 - Abilty to use custom sounds (mp3) in Chatsound, just move them in the audio dir and replace the existing 1-5

  • Fixed bug #75 - Sticky is now toggle able in GUI (/chatmod nofade)

  • Fixed bug #60 - /who windows keeps opening fix didn't work on all clients have to figure out why

  • removed Sync testing code

  • Fixed bug #77 - The Chatframe scroll down button is now individual placeable by draging the button where you want. Just hold down <CTRL> and drag it.

  • Fixed bug #73 - Updated Korean Language

  • Fixed bug #80 - Inchat highlighter shouldn't highlight names in items [xyz abc] any more

  • Fixed bug #85 - Gossip window of MC and BWL stays open after entering instance

  • Fixed bug #76 - Initchan should work now as it actually should

  • Fixed bug #56 - The general gossip bugs which prevent from talking to some NPCs should be fixed

  • Fixed bug #89 - Gossip window won't close in BWL/MC and no window on no option

  • Fixed bug #88 - "-" character will be correctly handeled in URL's

  • New Command (Bug #60) - /chatmod disablewho disables the who check to prevent the popping up who box on some clients

  • Fixed bug #102 - Gossip Window handling

  • Fixed Save Bug #124. Chatmod lua didn't saved correctly since last wow patch

  • Fixed Bug #128. First char after highlighted name was stripped

  • Fixed Bug #136. NPC Frames stay open.

  • Fixed Bug #113. Banker Gossip error

  • I Reverted the skip gossip function to pre 1.04 one. This is slower but more reliable. Many users got huge errors with the new routines.

1.04

  • SCCN_InChatHighlight added this will highlight known names in chatmessages and make them clickable  "/chatmod inchathighlight"

  • SCCN_AllSticky added to GUI / toggle Sticky mode, Bug #37

  • Storage method of playernames changed to lowercase, first preperal for unicode names

  • Updated the colortable, class colors should be brighter now

  • WHISPER is no Sticky Channel anymore, use the 'R' key ;p

  • Fixed [invite] Bug #36
    Invites not clickable anymore if from person in raid or from self

  • My Guild on EU-Aegwynn, United have defeated the Twin Emperors :D

  • Class colors updated again; Priest=brighter, Druid=more orange, Pala=better Pink (who gave the pala this color *cough*)

  • Fix for Bug #32 "Double lines in center of screen"

  • Request #31 included, Gossip skip more fluently

  • Gossip skip now includes Vendors

1.03

  • Enable Chat Stickyness by Default for GUILD,PARTY,RAID,OFFICER,SAY,WHISPER

  • Updated who Hide channel names work. This should now also hide custom channel names to it's number
    e.g.  [6. GuildsDruidChannel] will be [6] by clicking on [6] it will say 6 = GuildsDruidChannel

  • BG Minimap shouldnt toggle anymore if you switching between two BG's

  • Fix bug #22 - GEM's output shouldnt be visible in chatframes anymore

  • Fix bug #19 - Should intefere with CTRA anymore

  • Added KLHTM strip mentioned in Bug #22

1.02

  • Fix bug #10 (Line 159 error)

  • Fix bug #11 (Chronos check)

  • Fix bug #4  (Officer Chat)

  • Fix bug #16 (Party chat hotkey)

  • Preperal for bug #15 added a advanced DKPTable restore functionality. This requires interaction of the DKPTable mod author *Corss your fingers and ask him* I send him the neccesary fix information by PM on Curse.

  • Added command /chatmod fix to reHook the functions

1.01
- Fixed compatibility to DKP_Table Addon. For this compatibility Feature it is required to also have Chronos or Timex installed.
- Fix for Error in Line 654


At this Point The Addon was renamed from Sol's Color chat Nicks (SCCN) to ChatMOD.
The version will start again at 1.0

[1.9 & 1.9b]
- new: Chatsound Feature
- upd: highlighter now un case sensitive
- upd: chinese localisation updated
- upd: LookingForGroup naming fixed
- upd: keybinding file updated
- upd: removed OnEscapePressed events they are no longer valid
- upd: tidy up old code parts


[1.8]
- new: GUI to specify channel shortcuts (shortchannelname)
- new: added Option to toggle gossip skip to GUI
- new: added Option to toggle Auto Dismount to GUI
- new: /SCCN autodismount  toggle Auto Dismount feature
- new: /SCCN autogossipskip  toggle Gossip Skip Feature
- new: added GUI for Shortchanname config
- upd: Gossip Skip Msg removed
- upd: removed Zoning Time display, if you need it use catalyst
- upd: added KeyBindung for Chat /9 & /10
     


[1.7]
- new: The GUI. Bring it up with /SCCN
- new: /SCCN shortchanname ,displays a shorter version of the channelname
- new: Zone Loading times are displayed after loading screens
- new: Known Gossip Frames are skipped
(can temporary disabled by holding <CTRL> when NPC talk is initialized)
- new: Auto Dismount on talking to a Taxi NPC
(can disabled by holding <CTRL>)
- new: Unregistering Event handlers after player leaving world. (speedup)
- upd: fixed the invite highlight   [invite]d  thinks like this shouldnt happen anymore
- upd: general cleanup and optimization

[1.6]
- new: added Chinese Simplified (zhCN) translation by q09q09
- new: /SCCN highlight ; Specify customized highlightwords
- new: /SCCN AutoBGMap ; toggle bgminimap autotoggeling
- fix: some highlight problems fixed
- fix: some translationg problems fixed

[1.5]
- new: As soon as you enter a Battleground the BG Minimap automaticaly opens
- fix: /SCCN editboxkeys are back

[1.4]
- new: usage of HTML colorcodes in timestamps. e.g. /SCCN timestamp #33CCFF$h:$m
- fix: disabled /SCCN chatboxkeys because of 1.10
- 1.10 compatible

[1.3]
- new: Added key bindings for /6 /7 /8
- new: Added /SCCN hidechatbuttons Command to hide the chat buttons
- new: Forgotten chat Mod Support function. (FC has to be patched see on SCCN website)
- new: Binding for /wt  Whisper target
- fix: Own nickname should get highlighted in Word defense and local defense channel
- fix: Own Nick shouldn't get  highlighted in CTRA or DMSync Messages
- fix: Removed /who update event. It didn't work like expected and now a error caused by this was reported, reason to kick this out.
- fix: [invite] on click function didn't work propably since SCCN 1.2
- fix: chat keybindings now open complete empty editbox in past the binded key was printed sometimes

[1.2]
- new: Added Officers chat to keybinding options
- new: Added a support function for implementation in Forgotten Lords Chat Mod
- fix: Bug reported by grimman and RavenDk. Added space behind From:  and to:
- fix: Bug reported by xhile hopefully fixed. Editbox always got a reset even if topeditbox is off

[1.1b]
- fix: Bug in /raid say keybinding
- fix: Bug in hidechannames displyed empty brackets [] in raid / party / guild

[1.1]
- new: Keybindings in the wow config dialog for /say /raid /party /yell
- fix: checking not only if assistant for [invite] also if IsRaidLeader set
- fix: $h $m $s $t in timestamps are now alyways 2 digits. 01 instead of 1
- fix: Selfhighlight only highlight player said messages no system messages
- fix: stripped to much. raid party guild were removed from each string not only the channame
- upd: changed /tt to /wt (Whisper Target) because of conflict with other mods

[1.0b]
- fix: hide channame was broken for Guild / Raid / Party
- fix: German client line 737 error on /SCCN status

[1.0]
- new: if you hold <STRG> while mousewheel scrolling in the chatframe you going to top or to bottom
- new: command "/SCCN selfhighlightmsg" will toggle OnScreen display of highlighted messages. DEFAULT: on
- new: since this version the Timestamp string is customizeable. Please enter "/SCCN timestamp ?" for help.
- upd: some changes on the "hindechanname" routines. Chinese clients always shows a ugly ] should be fixed
- upd: accordng to the hidechanname update the SCCN_STRIPCHAN should now work correct
- upd: invite's will not be clickable in chatmessages written by your self
- udp: if you in a party and not party leader invite's also not clickable
- upd: converted map icons to .blp format saves minimal ressources
- fix: {invite] highlight problem in chinese client. Maybe fixed i have to play around because I don't have acces to a chines client ^^
- fix: /SCCN editboxkeys wansn't able to turn off so once turned on it stayed on no matter if toggled off or on
- fix: (old line 204 error) reported by Bray shouldn't happen anymore. (please test)

[0.9]
- new: Chinese localization (zhTW) added by Chris
- new: If selfhighlight is enabled you will get the messages including your name directly printed on screen
- new: increase the Editbox scrollback (history) buffer from 32 to 256 lines
- new: localized custom invite word. Search for SCCN_CUSTOM_INV in localization.lua to sepcify you own invite words
- new: /SCCN editboxkeys Use Chat Editbox keys without pressing <ALT> & increase History Buffer.
- new: /SCCN killdb This will kill your sccn Database. (100% empty afterwards)
- new: /tt Tell Target Command. Use "/tt text" to whisper "text" to your current target.
- fix: all help lines are showed
- fix: Your own nickname won't be highlighted if spoken by you

[0.8]
- Update: The hyperlinker now should support email adresses xyz@abc.de
- Update: Sasmira updated the Translation for all french users out there. Greetings to my country neighbors and big thanks to Sasmira!
- Fix: Hide own channel (set in localization.lua) should now work as intended
- Fix: highlighting of own Nickname didn't work sometimes. New regex works better
- Fix: another change in the colored raid map pins code to workaround those evil bugs on some clients. I'm keep praying ;)


[0.7]
- New: /SCCN clickinvite . Make the words "invite" and "inv" clickable in the chat. If you click on such a invite the user automaticaly get's an invite request. Quite usefull in BG's ;p all this "invite plz!!!"
- New: Hide own custom channels. Simple open the localization.lua in a texteditor and SCCN_STRIPCHAN[4] SCCN_STRIPCHAN[5] and so on.
- New: Confab compatibility. If confab (an other addon) is detected SCCN editbox features are disabled due to compatibility reasons.

[0.6b]
- QuickFix for nil error in 311 on startup.

[0.6]
- Fix: NIL Error in line 126
- Fix: NIL Error in line 269
- Fix: Map pin color error on some clients. (still experimenting, strange behavior sometimes)
- New: Url Highlighting advanced to URL's with ports like TeamSpeak (sub.domain.og:12345)
- New: Url Highl. adv. to IP Adresses with ports (123.456.789.123:12345)
- New: /SCCN selfhighlight If a other person mention your char's name in a chat your name will be highlighted

[0.5]
- New: "/SCCN hyperlink" if toggled on URL's in the chatwindow are clickable and ready for copy & paste
- Fix: Hidechanname now completely hides channel names. Also [Guild] [Raid] [Party]
- Small fixes

[0.4]
- Fix: Button placement was moved
- New: /SCCN colormap Colors the map pin's of raid users in their class color

[0.3]
- French localization added. Thanks to Sasmira
- Function added to hide channel names
- Function added to Scroll chatframe with mousewheel
- Function to relocate the Editbox to the top of the chatwindow
- Function to add a 24h timestamp
- Commandline option /SCCN added. Type without parameters for help.
- /SCCN hidechanname = Will supress the Channelname (default: off)
- /SCCN colornicks = Toggle Nick coloring on and off (default: on)
- /SCCN purge = Start the normal purge process done every start
- /SCCN timestamp = add a timestamp
- /SCCN topeditbox = relocate the editbox to the top of the chatframe

[0.2]
- general optimization
- if char isn't known default color should be used
- Added display of currently used memory and purged entrys
- Changed Storage. 0.1 stores the class name "DRUID" 0.2 only stores a kind of placeholer (less memory)
- Changed Purgetime to 4 Weeks
- Added WHO_LIST_UPDATE event. But this isn't working as intended ;(
Have to figure out how to catch single /Whois commands.

[0.1]
initial release