Developer Tool for API documentation. Useless to the general public.
An API Debugger made into an addon format, based entirely on code available at thewarwiki.com. It registers all event handlers, and will print event information to the debug window when they occur. Basic framework for printing special variables at time of event included in lua comments.
If anyone wishes to use it, feel free to add information regarding the events to http://thewarwiki.com/wiki/API:Event_List so that all may benefit.
TODO: Add SavedVariables data collection
WARNING: Do not remove the unregister of event UPDATE_PROCESSED unless you have to. It fires every frame.
UPDATE 1.8: Due to changes how loading works, will initialize at ENTER_WORLD or RELOAD_INTERFACE. Once in game, you can manually edit the lua file and tell it to NOT delayed initialize, and it will initialize fine if you're reloading the interface, but don't leave it set that way, as it will crash when you restart the client. If this occurs, you need to edit the lua to perform the delayed initialize again.
Also, the DevBar tool is a great compliment to apidebugging, available at http://code.google.com/p/devbar/. Due to copyright issues since its a default UI addon for developers, I will not put the project on Curse.
------------------------------------------------------------------------
r34 | felyza | 2008-10-21 09:31:26 +0000 (Tue, 21 Oct 2008) | 1 line
Changed paths:
A /tags/V1.8-Release (from /trunk:32)
R /tags/V1.8-Release/APIDebugger.lua (from /trunk/APIDebugger.lua:33
Code cleanup. Modifications to delayed initialize due to changes in UPDATE_PROCESSED and how isLoading is handled. Does not initialize until ENTER_WORD or RELOAD_INTERFACE.
------------------------------------------------------------------------
r31 | felyza | 2008-10-10 03:44:22 +0000 (Fri, 10 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
------------------------------------------------------------------------
r29 | felyza | 2008-10-10 03:32:20 +0000 (Fri, 10 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
No longer crash on load due to changes in Event Handling
------------------------------------------------------------------------
r26 | felyza | 2008-10-03 13:11:04 +0000 (Fri, 03 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.mod
------------------------------------------------------------------------
r21 | felyza | 2008-10-02 23:59:08 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
DelayedInit working at enter world. Thanks Aiiane for the idea!
------------------------------------------------------------------------
r18 | felyza | 2008-10-02 22:34:46 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
Remove requirement of manually disabling every game run.
------------------------------------------------------------------------
r17 | felyza | 2008-10-02 19:41:10 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
Small Update
------------------------------------------------------------------------
r15 | felyza | 2008-10-02 17:16:00 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
M /trunk/APIDebugger.mod
Working
------------------------------------------------------------------------
r14 | felyza | 2008-10-02 15:37:14 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
------------------------------------------------------------------------
r11 | felyza | 2008-10-02 14:22:54 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
M /trunk/APIDebugger.lua
Trying SVN Commit
------------------------------------------------------------------------
r10 | felyza | 2008-10-02 14:12:35 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
A /trunk/APIDebugger.lua
------------------------------------------------------------------------
r9 | felyza | 2008-10-02 14:12:28 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
D /trunk/APIDebugger.lua
------------------------------------------------------------------------
r8 | felyza | 2008-10-02 14:02:59 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
D /trunk/APIDebugger
------------------------------------------------------------------------
r7 | felyza | 2008-10-02 14:02:50 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
D /trunk/APIDebugger/APIDebugger.mod
A /trunk/APIDebugger.mod (from /trunk/APIDebugger/APIDebugger.mod:6
------------------------------------------------------------------------
r6 | felyza | 2008-10-02 14:02:31 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
D /trunk/APIDebugger/APIDebugger.lua
A /trunk/APIDebugger.lua (from /trunk/APIDebugger/APIDebugger.lua:5
------------------------------------------------------------------------
r5 | felyza | 2008-10-02 13:57:32 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
A /trunk/APIDebugger
A /trunk/APIDebugger/APIDebugger.lua
A /trunk/APIDebugger/APIDebugger.mod
Directory this time
------------------------------------------------------------------------
r4 | felyza | 2008-10-02 13:57:03 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
D /trunk/APIDebugger.lua
D /trunk/APIDebugger.mod
------------------------------------------------------------------------
r3 | felyza | 2008-10-02 13:54:36 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
A /trunk/APIDebugger.mod
Attempting first SVN access
------------------------------------------------------------------------
r2 | felyza | 2008-10-02 13:54:35 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
A /trunk/APIDebugger.lua
Attempting first SVN access
------------------------------------------------------------------------
r1 | root | 2008-10-02 13:28:20 +0000 (Thu, 02 Oct 2008) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"apidebugger/mainline: Initial Import"
------------------------------------------------------------------------
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)...