LibFilter - Filtering for you!
Current Author: instant (instant0@gmail.com)
Version: Release 1.0 beta (2008-11-21)
Website: http://www.bod-guild.com
-------------------------------------------------------------------------
What is LibFilter:
LibFilter is a library that addon authors can utilize to create custom
filters to use for sending chat messages to the client.
By using a custom filter, you have the option to pick the colour and
what tab to display the text in, and you also give the user customization
options(*) to decide him/herself where they want the text to be displayed,
and how it should look.
-------------------
How does it work:
-------------------
LibFilters adds the supplied information (supplied by developer using the library) to the ingame chat filtering database.
This is done through the following code:
LibFilter.AddCustomFilter(UNIQUEID, FRIENDLYNAME, TAB, R, G, B)
Example:
LibFilter.AddCustomFilter(1234, "Addons", 1, 255, 190, 0)
The formatting is as follows:
- UNIQUE ID, FRIENDLY NAME, CHAT TAB, RED, GREEN, BLUE
- UNIQUE ID for the chat text. This is the "ID" you will send text to using for example:
local outp = "Hello World, Hei og Hopp";
TextLogAddEntry("Chat", 1234 , StringToWString(outp));
As you see we use the value '1234' in TextLogAddEntry, the same as our UNIQUE ID above. This can easily be replaced with a variable you define at the start of your project.
The "Chat" text needs to be supplied. StringToWString is optionable, depending on the text/values you are printing out.
- FRIENDLY NAME is the name the user will see in his filtering/colouring options
- CHAT TAB is the chat tab the text is to be output to. Currently the Library removes filtering for all other chat tabs for the specified ID. By Default, Chat is 1, Combat is 2, etc.
- RED, GREEN, BLUE are the RGB values from 0-255 for each colour value. The source code for LibFilter contains a small list of some of the most used colours.
------------------
KNOWN LIMITATIONS
------------------
* This library does not remember the user settings between each session
(nor does the game for that matter)
* This library will only add the chat text to 1 channel, unless the user selects more (which of course, the settings will be reset upon CTD/Logou/Reloadui)
------------------
THANK YOUS
------------------
- WAR Addon Community
- WARDIFF at http://code.google.com/p/wardiff/
2008-11-21
- Initial Deployment
- Utilized by WARM2L2 (Warhammer Mobs 2 Level)
Installation Guide
- Exit "Warhammer Online" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Verify your WAR Installation Path
That is where you are running WAR from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your Warhammer Online folder. (default is C:\Program Files\Warhammer Online\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start Warhammer Online
Translations
When you download a mod, please be sure that the mod is compatible with your translation of WAR. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
Directory Structure
Warhammer Online
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.mod
|_ *AddonName*.lua
|_ (possibly others as well)...
