Easy to use serialization library for Warhammer.
Features
- Supports the use of most data types as table keys, including tables, booleans, and wstrings.
- Tables containing circular references are properly serialized and references restored when deserialized.
- Functions cannot be pickled, instead they are replaced by a wstring to allow pickling of large objects and table structures without having to remove them first, try pickling GameData or SystemData sometime!
- All serialized data is output as wstrings.
- Low serialization overhead, strings are as compact and short as possible
Loading LibPickle
- Copy LibPickle.lua and LibStub.lua to your project and add the following to the files section of your .mod file
<File name="LibStub.lua" />
<File name="LibPickle.lua" />
Using LibPickle
Once loaded you can either use LibStub to reference LibPickle
LibPickle = LibStub("LibPickle-0.1")
then
LibPickle.pickle(table)
LibPickle.unpickle(wstring)
or you can just use the global function directly without the nead to use a local reference to LibPickle
outputWString = Pickle(table) -- will output wstring
restoredTable = Unpickle(outputWString) -- will output table
- Note: If you need a to access a specific version of LibPickle, use the LibStub method instead of the global, which will be overwritten by the last version loaded
Happy pickling!
Addons Using LibPickle
Aura
- If you use LibPickle in your addon leave me a message and I'd love to add your addon to the list
2009-01-31 Bloodwalker <metagamegeek@gmail.com>
* LibPickle.lua
Minor version increment
[df0470a6a26b] [beta-0.2.2]
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)...