Diese Seite auf Deutsch

KQuote allows you to "send" audio quotes through WoW's chat channels.

KQuote can't really send audio to other players though. Instead it will post a normal text message into the chat channel, which contains an ID of the desired quote.
Provided the receiver has KQuote installed, it will recognize that ID and play the appropriate sound.


KQuote is based on WoWQuote by Lev@Die Ewige Wacht and Harag@Die Ewige Wacht. Many thanks to both of them!

Download Page  

Contents

Basic Usage
Features
Console Commands
Compatibility with WoWQuote2
Create Media AddOns
Tools needed
Step by Step
Common Problems
 

Basic Usage

Contents

KQuote does not usually display a user interface. It's working in the background, catching quotes and playing the appropriate audio files.

To send audio quotes yourself, you either use console commands or you open the main window.

The main window can be opened by typing /kq into the chat console.

It is also possible to assign a keyboard shortcut to open the main window or – in case you've got a broker display installed – you may use the KQuote button that should be visible there.

Select a channel to post to, find a quote and double-click to send it.

 

Features

Contents
LDB Plugin
In case you've got a Broker Display AddOn installed (Bazooka, ChocolateBar, …) you'll get a KQuote button to quickly open the KQuote main window or the options panel.
Options Panel
You'll now find an options panel for KQuote in the WoW Interface-AddOns dialog. Use /kqopt to open it from the command line.
Channel Selection
The options panel lets you select the channels KQuote should listen to. Only channels selected here will play audio. This was always available via the command line (/kqc) but is a lot more convenient now.
Say, Yell and Whisper
KQuote is able to post to Say and Yell and to send a quote via Whisper. The channel needs to be activated by the recipient for him to hear anything. Yell and Whisper are off by default.
Warning: Spamming the Say or Yell channel may lead to lots of ignores and possibly a spam complaint. That's your fault then, not that of the AddOn. ;)
Auto-Mute in Fight
It is possible to have KQuote auto-mute playback while you are in-fight. This is especially useful for raid encounters but may be activated for single play up to battlegrounds. Additionally you may select one or more groups of channels to mute. It is possible for instance to allow audio playback from the raid channel but mute the guild channel while in fight.
Emotes
A media package may assing an emote to a quote. This may be a standard emote like '/dance' or some custom text. Please note that emotes are played only while posting to the Say channel. (People in other channels are unlikely to be able to see your emote anyway.)
Mute
Use /kqm to mute KQuote. Typing /kqm a second time will re-enable playback. This setting is not remembered after logout.
You may assign a key to this function, using WoW's Options – Key Bindings dialog.
Since version 1.4 there's also a Mute button at the top of the main window.
Tags
Each quote may have multiple tags assigned to it. Use the popup menu on the upper right of the main window to filter quotes by tag. This works in combination with the search field.
Search Field
There's a text input field in the upper right of the KQuote window. Entering a search term will filter the quote list to only display quotes that contain that term. This does work in combination with the tag pop up.
Quick Search
Adding a search term at the end of the /kq command will insert that term into the window's search field. /kq -t <tag> will select the corresponding entry in the tag pop up menu.
Aliases
Use /kqa to assign an alias to a quote. You may then use this alias on the command line instead of the quote's ID. So you could, for instance, type /kqp mana to send the manamana song to the party channel.
Separate Media Packages
For KQuote I moved the actual media data to separate addons. There are several advantages to this approach:
  1. There's no need to re-download audio data for every small change to the main addon.
  2. It is possible to create additional media addons that can be loaded and updated without affecting already existing quotes.

Read more about creating media addons here.

 

Console Commands

Contents
/kq [<search term>|-t <tag>]
Open or close the selection window.
A given search term will be entered into the search field, a tag will select the appropriate entry in the tag pop up menu.
/kqh
Print a list of chat commands.
/kqopt
Open the KQuote options panel.
/kqm
Mute playback. This setting is not saved between sessions. Playback is always on when you log in.
/kqc [<channel>] ["on"|"off"]
Display or change channel settings. Channel may be one of: s(ay), y(ell), w(hisper), g(uild), o(fficer), p(arty), r(aid) or b(attleground). This setting is retained between sessions.
/kqt
Print all tags with descriptions. The tag description is what you can see in the tag pop up menu.
/kql <tag>
List all quotes that are tagged with <tag>.
/kqf <search term>
List all quotes that contain <search term>.
/kqa [<alias> [<quote id>]]
Create an alias for a quote. In case the quote id is omitted, the given alias will be deleted.
/kqw [<player>] <quote id|alias>
Whisper to player or current target.
/kqs <quote id|alias>
Post to your surroundings.
/kqy <quote id|Alias>
Yell to your surroundings.
/kqp <quote id|alias>
Post to the party channel.
/kqg <quote id|alias>
Post to the guild channel.
/kqr <quote id|alias>
Post to the raid channel.
/kqb <quote id|alias>
Post to your battlegroup.
/kqo <quote id|alias>
Post to the officers' channel.
 

Compatibility with WoWQuote2

Contents

Media AddOns for WoWQuote2 will work with KQuote and vice versa.
(WoWQuote2 did adopt the plugin technique from KQuote by the way.)

KQuote will receive and play all quotes sent from WoWQuote2. The other direction will only work for channels that are supported by WoWQuote2. So quotes send to the say, yell, whisper or officer channels will not be heard by WoWQuote2 users.

 

Create Media AddOns

Contents

Media AddOns require KQuote to function. Still, technically they are the same as stand alone addons.
That is they follow the same folder structure and are installed in exactly the same way.

 

Tools needed

Contents  

Step by Step

Contents
  1. Download this Media addon template (KQMediaTemplate.zip, 6 KB).
  2. Unzip the archive and replace the text "Template" in the folder's name with a term that fits your new addon. (The resulting folder name might be something like "KQMediaMine".)
  3. The file names of the two files inside that folder (KQMediaTemplate.toc and MediaTemplate.lua) need also be changed accordingly.
  4. Open the .toc file and replace all occurences of "Template" with your new name. You should also update the remaining tags like Author, URL and Title.
  5. Now open the .lua file and replace all occurences of "Template" in that one too. (All affected lines are marked with !!!.)
  6. Then locate the line local moduleid = "tpl"; and replace the tpl with a key for your addon. This key needs to be unique. You can only use one media addon with the same key at any one time. In addition, the key should be as short as possible, since it is part of the quote id that will be posted to the chat for every quote.
  7. Next, find these lines …
    -- replace this list of data with your own
    -- end of media data
    … and between them add the meta data for your quotes. You can find a description of the necessary format here.
  8. As a last step you need to copy the audio files for your quotes (in MP3 format preferably) into the media folder inside the addon's main folder.

You now have your own media addon for KQuote!

Move it to WoW's AddOns folder and restart WoW. Make sure the addon is actually activated and log in. You should now be able to select and play your new quotes. All that is left is to distribute your new addon to your friends. :)

 

Media Meta Data

Contents

A media addon's .lua file contains meta data about all its quotes. Each entry for a quote looks like this:

{
    id = "tpl:02",
    file = "secondfile.mp3",
    len = 4,
    msg = "Description for second file",
},

The id consists of the addon's key followed by a colon and an index number.

file is the name of the audio file inside the media folder.

len is the length of the quote in seconds.

msg is a short description for the quote.

Optionally, an entry may have one or more tags assigned:

{
    id = "tpl:02",
    file = "secondfile.mp3",
    len = 4,
    msg = "Description for second file",
    tags = {"hi", "rogue"}
},

This quote will be listed under Hi and Rogue. You can find the definitions for the standard tags in the file KQuote-enUS.lua inside the KQuote/Locales folder.

 

Common Problems

Contents
The AddOn does not load.
Make sure that …
  • … the name of the .lua file mentioned inside the .toc file matches the actual file name.
  • … you did indeed replace all occurences of Template with your new name.
WoW displays an error on log in.
Make sure you didn't make any changes in the .lua file that result in a syntax error — like removing a comma or semicolon for instance.
One or more sounds won't play.
  • WoW can play sound files in MP3 or WAV format only.
  • Make sure all file names inside your .lua file match the names of the actual sound files inside the media folder.
Umlauts or other special characters don't display correctly.
The .lua file must be saved using UTF-8 encoding. Check the settings of your text editor.