Description
A simple library providing some commonly used utility functions. This library solves the problem of reading and writing to a file for communication with an external program!
Reporting Bugs
Post Bugs HERE
Requirements
LibCereal-1.0 must be installed.
Function Documentation
LibUtils.Chat( text ) / Chat( text )
Description
Sends a line of text to the primary chat window.
Parameters
text - A line of text in either string or wstring format.
Returns
Nothing
LibUtils.Dbg( text ) / dbg( text )
Description
Sends a line of text to debug window.
Parameters
text - A line of text in either string or wstring format.
Returns
Nothing
LibUtils.Dump( lua_object, label ) / Dump( lua_object, label )
Description
Prints out the lua_object in string format to the Chat window. It uses
the chat window rather than the debug window because the debug window truncates the output.
Parameters
lua_object - Any lua object
Returns
Nothing
LibUtils.LoadFile( filename )
Description
Loads and de-serializes the contents of a file created by LibUtils.SaveFile()
Parameters
filename - The name of the file to load.
Returns
A single Lua object
LibUtils.PlayerName()
Description
Determines the name of the current character.
Parameters
none
Returns
A string containing the name of the current character.
LibUtils.SaveFile( filename, lua_object )
Description
Stores a single lua object (such as a table or a string) to the named file.
Parameters
filename - The filename to write to.
lua_object - The object to be stored.
Returns
Nothing
LibUtils.SendCommand( cmd )
Description
Causes a single slash command to be executed. For example, "/target maudib"
Parameters
cmd - Either a string or widestring to be executed.
Returns
Nothing
LibUtils.StrJoin( ) / strjoin()
Description
Parameters
Returns
LibUtils.StrSplit() / strsplit()
Description
Parameters
Returns
History
Version 0.02 Release: Dec 19, 2008
- Version 0.02 has been promoted to Release status since it appears to be working without known issues.
Version 0.02 Beta: Dec 11, 2008
- The Warhammer 1.10a patch changed the format of log files by sticking an extra space into the line header. This prevented us from reading back data from the files correctly. Changed to accomodate.
- Changed the order of the parameters to LibUtils.Dump() to allow the title to be optional.
Version 0.01 Beta: Dec 9, 2008
Introduction of this library.
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)...
