This addon provides functionality to other addons by allowing them to create their own achievement entries in the Tome of Knowledge. You won't notice anything just by installing this addon without other addons using it!
This is work in progress so the interface, function names, etc. might still change!
Provided functions
LibAchievements.CreateCategory(name)
Creates the category named "name" (if it doesn't exist yet) and returns the addon internal ID used in other functions.
name (string/wstring): The name of the new category.
return value (int): The created (or found) category's ID.
LibAchievements.CreatePage(catid, name, unlocked, desc)
Creates the page named "name" (if it doesn't exist yet) in the category identified by ID and returns its ID.
catid (int): The ID of the category (see above) where the page should be added.
name (string/wstring): The name of the new page.
unlocked (bool): Determines if the page's entry is clickable.
desc (string/wstring): The description to show on the page once it's opened.
return value (int): The created (or found) page's ID.
LibAchievements.AppendEntry(pageid, name, desc, func)
Adds a new achievement entry to the page and returns its ID.
pageid (int): The ID of the page (see above) where the entry should be added.
name (string/wstring): The name of the entry.
desc (string/wstring): The description text of the entry.
func (function returning bool): The function to check, if the entry is unlocked (will be called and has to return a boolean value (true/false))
return value (int): The created entry's ID.
LibAchievements.UpdateEntry(pageid, entryid, name, desc, func)
Updates an entry by modifying name, description, etc.
entryid (int): The ID of the entry that should be modified.
For other parameters read "AppendEntry".
Right now there is no way to remove categories/pages/entries "on the fly" but in the rare case you'd have to do it, you could just modify LibAchievements.Categories and LibAchievements.Pages.
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)...
