===========================================================================
= KayrChat - RP Chat Addon for World of Warcraft
= Copyright (c) Kvalyr - 2012 - All Rights Reserved
===========================================================================
================
Authorized Download Locations:
========
WoWInterface.com
================
Description & Features:
========
+ All major features can be toggled at any time by the user through the addon's options menu. (Esc Menu -> Interface -> Addons -> KayrChat or type "/kc")
+ Language tagging without obfuscation for the benefit of fellow RolePlayers
- Example: Choosing to send a message in the Thalassian language will actually
send the message in the Orcish language, but with a prefix of "[Thalassian]".
- The message will look identical to one sent using the actual in-game Thalassian
language but players of other races will be able to read it, thus
facilitating more inclusive RP.
- This functionality also optionally limits non-common languages to specific
channels (such as /s and /y) to prevent accidental language usage in guild,
etc.
- This feature can be switched off at any time to return to normal (Blizzard)
language functionality.
- This does NOT bypass Blizzard's languages when used by other players. It will not
allow you to understand other players speaking languages that your race
cannot read, unless they too are using this addon (because then their message
will actually be sent in your faction's common language, but with a language
tag to make it appear otherwise).
+ Multiline messages - Removes the 255-character limit from the default chatframe editbox and allows
messages longer than 255 characters to be typed, which will be automatically
split into multiple chat messages as appropriate.
- The addon can also optionally warn the user that their message will be split.
+ LibDataBroker Plugin - An optional LDB plugin is available here for KayrChat which offers the same functionality
as the built-in Language button.
KayrChat_LDB
================
Usage:
========
+ Language: - Left-click the Language button to toggle between available languages.
- Right-Click and drag the Language button to change its location on the screen .
(or use the sliders in the options menu)
- Middle-click the Language button to open the options menu.
- Language features can be toggled from the options menu at any time.
- The game's built-in (obfuscated) racial languages can be enabled again at any time
by toggling off the "Deobfuscation" option.
- The "Hide Faction Language" option, when enabled, prevents [Orcish] or
[Common] from being preprended to your messages when speaking those languages.
+ Multiline: - Simply type long messages!
- The Multiline message-split will only occur when your message exceeds the limit
imposed by Blizzard on length for messages sent to other players or channels.
- The automatic splitting can be toggled from the options menu at any time.
- The option to Add a 'splitter' symbol between split messages simply places a '--' at the end of posts being split into multiple messages.
An option to specify the splitter symbol will follow in a future version.
- The "Show split message warning", when enabled, will flash a warning on your
screen when the current message being typed exceeds Blizzard's limit and will
be split into multiple messages when sent.
================
Installation:
=======
+ Standard addon installation - Place the "KayrChat" folder inside the "[WoW Folder]\Interface\Addons" folder.
================
Requirements & Compatibility:
=======
+ WoW 5.x (Mists of Pandaria) - Cataclysm compatibility ended with KC 0.3.3
+ Compatibility Fixes are in place for the following addons: - LanguageCycle by Halya
- 'Compatible' in that it attempts to use LC's saved language setting
to determine which language KC should use. Requires testing!
- Misspelled by nrpieper
- Compatibility workaround fix available and enabled by default
- Only disable this if you experience problems and need to troubleshoot.
- TotalRP2 by Telkostrasz
- Compatibility workaround fix will be automatically enabled if you try to use
KayrChat's multiline functions when TotalRP2 is installed
- Only disable this if you are prepared to disable chat functions in TotalRP2's
options
- Gryphonheart Items v1.4.0
- Compatibility workaround fix will be automatically enabled if you try to use KayrChat's multiline functions when GHI is installed
- GHI will interfere with any message (sent/recieved) containing something of the form '[someText]', with or without KayrChat.
Enabling this workaround fix will change the language tag to the form '{Language}' to avoid GHI's interference.
- The workaround can be disabled if GHI gets updated for compatiblity with other addons such as KayrChat
- Tongues
- KayrChat Language functions are disabled when Tongues is in use.
+ KayrChat embeds ChatThrottleLib by Mikk (More info. in ChatThrottleLib folder)
+ KayrChat hooks functions in a manner such that it's more likely that other addons will break
KayrChat than KayrChat breaking other addons! (That's the theory, at least..)
+ Please report any incompatibilities discovered to Kvalyr on the WoWInterface.com page for this addon.
================
Planned Features:
========
+ User-configurable per-channel options
In a future version there will be an option for the user to choose which channels to manage language usage in with fine-grain control.
+ Emphasised Messages- Emphasis of specific conversation participants using varying font size or colour in the chat window to make it easier to follow a specific conversation and its participants in a crowded area.
+ Enlarged EditBox for default chatframe to complement multiline functionality
================
Credits/Contact:
=======
Contact Email:
wowaddons at valyr dot net
+ Kvalyr (Author)
+ Mikk for ChatThrottleLib
+ Members of Bladesong RP Guild (Argent Dawn EU) for testing, feedback and suggestions
KayrChat & KayrLib - Copyright 2012 Kvalyr - All Rights Reserved
Modification or redistribution without EXPLICIT consent from the author is prohibited and
considered a breach of copyright.
===========================================================================
================
Known Issues:
=======
+ V1.4.0 of Gryphonheart Items mixes up the order of KayrChat multiline messages when it
intercepts the language tags ([Orcish], etc.) as suspected Item Links.
- Compatibility fixes in KayrChat are in place and a recommendation has been made to GHI authors
on implementing the fix at their end.
- KayrChat users can enable a compatibility fix which uses { } brackets on language tags instead of
[ ] brackets.
- When V1.4.0 of GHI is present and the above fix is not enabled, KayrChat warns the user and
automatically disables Multiline functionality as a temporary workaround for this issue until a
compatible version of GHI is installed.
+ TotalRP2 mixes up the order of KayrChat multiline messages or occasionally causes duplicates or message corruption when its chat functions are enabled.
- Disabling chat functions in TRP2 fixes the problem
- KayrChat warns the user and switches to a version of SendChatMessage hooked in the addon loading process (instead of one hooked during PLAYER_ENTERING_WORLD) to get around this issue as a temporary fix until a more robust solution can be worked out.
================
Hosting:
=======
Hosting of this addon on any site other than those listed in the 'Authorized Locations' section above (or in the addon files) is a violation of copyright and strictly prohibited.
For security, do not download this addon from anywhere other than wowinterface.com
===========================================================================
10-16-12, 06:17 PM
