View source for WormKit

{{ParentArticle|[[Software]]}}
{{Software_infobox
| icon = WormKit_icon.png
| name = WormKit
| developer = [[People/CyberShadow|CyberShadow]]
| games = [[Worms Armageddon|W:A]]
| waver = All versions
| language = Delphi
| license = Open-source<ref name="cybershadow-github"/>
}}

'''WormKit''' was an extension framework for [[Worms Armageddon]]. The distribution contained a module loader (whose only purpose is to load WormKit modules), and a set of default modules, each providing specific functionality.

By convention, a WormKit module is a DLL file, the filename of which begins with the prefix "wk". There is no API or further integration, however some DLLs can provide common functionality for other modules to share (such as wkPackets).

Starting with W:A version 3.7.0.0, the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.

== Modules ==

=== Original modules ===

{|
|-
! style="width:155px" | Name
! style="width:550px" | Short description
! style="none" | Com.
! style="none" | W:A version
! style="none" | Developer
|-
| '''[http://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" />
| Stop Worms from disabling Alt+Tab / Win+... keyboard combinations.<ref name="loader-only">This module will not work with the game's "Load WormKit modules" option. A loader (WormKit.exe or [[WormKitDS]]) must be used instead.</ref>
| {{WA editions|cd|steam}}
| All
| [[People/CyberShadow|CyberShadow]]
|-
| '''[http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride]'''<ref name="cybershadow-github">Source code for WormKit and default modules can be found on [https://github.com/CyberShadow/WormKit GitHub].</ref>
| Override files from the CD-ROM with your versions.
| {{WA editions|cd|steam}}
| All
| [[People/CyberShadow|CyberShadow]]
|-
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" />
| Choose the soundcard W:A should use for sound output.
| {{WA editions|cd|steam}}
| All
| [[People/CyberShadow|CyberShadow]]
|-
| '''[[WormNAT2]]'''
| Allows hosting games even if you're behind a router or firewall.
| {{WA editions|cd|steam}}
| 3.6.28.0+
| [[People/CyberShadow|CyberShadow]]
|}

=== Current modules by community ===

{|
|-
! style="width:155px" | Name
! style="width:550px" | Short description
! style="none" |  Com.
! style="none" |  W:A version
! style="none" |  Developer
|-
| '''[http://myfiles.my1.ru/wa/wk/wkAntiLag.dll AntiLag]'''
| A simple module to fix the screen lags in-game by increasing the WA.exe process priority.
| {{WA editions|cd|steam}}
| All
| [[People/Kawoosh|Kawoosh]]
|-
| '''[http://myfiles.my1.ru/wa/wk/wkD3D9Wnd.rar D3D9Wnd]'''
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
|-
| '''[[wkIndiMask|IndiMask]]'''
| It allows maps to have both destructible and indy areas by embedding data in the palette.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Plutonic|Plutonic]]
|-
| '''[[wkKawooshKick|KawooshKick]]'''
| An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkLobbyCmd|LobbyCmd]]'''
| Allows to change the in-game resolution from a network game lobby to any value.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[MapGEN]]'''
| Allows to generate random PNG maps from the map editor.
| {{WA editions|cd|steam}}
| All
| [[People/Plutonic|Plutonic]]
|-
| '''[http://myfiles.my1.ru/wa/wk/wkNV3Doff.dll NV3Doff]'''
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.
| {{WA editions|cd|steam}}
| All
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkRehost|Rehost]]'''
| Allows reopening games when using a snooper to host.
| {{WA editions|cd}}
| 3.7.2.1 {{and lower}}
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkRemapKeys|RemapKeys]]'''
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.
| {{WA editions|cd|steam}}
| 3.7.2.1
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
|-
| '''[[ReplayShark]]'''
| Allows to build a catalog of nice moments by pressing a button when something cool happens.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Glide|Glide]]
|-
| '''[[RubberWorm]]'''
| Extends the W:A physics engine with new options.
| {{WA editions|cd|steam}}
| 3.7.2.1 {{and lower}}
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''
| A module which in future will help to run WWP and older W:A on Wine.
| {{WA editions|cd|steam}}
| All
| [[People/Muzer|Muzer]]
|-
| '''[[wkWMDB]]'''
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.
| {{WA editions|cd|steam}}
| All
| [[People/Plutonic|Plutonic]]
|-
| '''[http://forum.team17.com/showthread.php?t=57737 wndmode]'''
| DirectDraw windowed mode running in a wrapper.
| {{WA editions|cd|steam}}
| All
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
|}

=== Developer modules, SDKs, debuggers ===

{|
|-
! style="width:155px" | Name
! style="width:550px" | Short description
! style="none" |  Com.
! style="none" |  W:A version
! style="none" |  Developer
|-
| '''[http://forum.team17.com/showthread.php?p=682309#post682309 MinidumpOnCtrlBreak]'''
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.
| {{WA editions|cd|steam}}
| All
| [[People/CyberShadow|CyberShadow]]
|-
| '''[[wkPointerScan|PointerScan]]'''
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.
| {{WA editions|cd|steam}}
| All
| [[People/Pisto|Pisto]]
|-
| '''[http://myfiles.my1.ru/wa/wk/wkVersionCheck.zip VersionCheck]'''
| An example on C++ to verify the W:A version before hooking code.
| {{WA editions|cd|steam}}
| All
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkSample]]'''
| The example open source module, which shows the development of WormKit modules.
| {{WA editions|cd|steam}}
| All
| [[People/TheSCS|The SCS]]
|}

=== Obsolete or incompatible modules ===

{|
|-
! style="width:155px" | Name
! style="width:550px" | Short description
! style="none" | Com.
! style="none" | W:A version
! style="none" | Developer
|-
| '''[http://forum.team17.com/showthread.php?t=38762 ColorFix]'''
| Fixes the color bug on Vista and Windows 7 by suspending an "explorer.exe" process.
| {{WA editions|cd|steam}}
| All
| [[People/CyberShadow|CyberShadow]]
|-
| '''[[wkPathOverride|PathOverride]]'''
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.
| {{WA editions|cd}}
| All
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[wkRandomMap|RandomMap]]'''
| Allows you to download random maps from [[WMDB]] directly from the map editor.
| {{WA editions|cd|steam}}
| Undefined
| [http://shadowtheage.narod.ru ShadowTheAge]
|-
| '''[[wkPrivateCfg|PrivateCfg]]'''
| Allows you to store all the W:A settings in an INI file instead of registry.
| {{WA editions|cd}}
| 3.7.0.0 {{and lower}}
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[FkeyRearrange]]'''
| Allows user to redefine weapons order and content for each F hotkey.
| {{WA editions|cd}}
| 3.6.31.0 {{and lower}}
| [[People/boobl|boobl]]
|-
| '''[[WA_Localizer|Localizer]]'''
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.
| {{WA editions|cd}}
| 3.6.31.0
| [[People/Kawoosh|Kawoosh]]
|-
| '''[[Project X]]'''
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.
| {{WA editions|cd}}
| 3.6.31.0
| [http://px.worms2d.info Entuser]
|-
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''
| Fixes the Darker team colour scheme when PX is enabled.
| {{WA editions|cd}}
| 3.6.31.0
| [[People/Kawoosh|Kawoosh]]
|-
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''
| An analog to wKick module for W:A update 3.6.29.0.
| {{WA editions|cd}}
| 3.6.29.0
| [http://worms.cinus.org Cinus]
|-
| '''[[JetFix]]'''
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].
| {{WA editions|cd}}
| 3.6.29.0
| [[People/Pisto|Pisto]]
|-
| '''[[LaserFix]]'''
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.
| {{WA editions|cd}}
| 3.6.29.0
| [[People/Pisto|Pisto]]
|-
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.
| {{WA editions|cd}}
| 3.6.28.0
| [[People/Pisto|Pisto]]
|-
| '''[[wkMagic]]'''
| First proof-of-concept module that allowed game logic code modification in online games.
| {{WA editions|cd}}
| 3.6.26.5
| [[People/CyberShadow|CyberShadow]]
|}

=== Non-W:A modules ===

{|
|-
! style="width:155px" | Name
! style="width:550px" | Short description
! style="none" | Apps
! style="none" | App version
! style="none" | Developer
|-
| [[Resolution Changer|ResoChanger]]
| Allows to change the in-game resolution in Worms 2 to any value, respecting caverns.
| {{software|W2}}
| 1.05
| [[People/StepS|StepS]]
|}

== History ==

WormKit was first released on April 5, 2006. Since its release, no significant changes or additions were made to the framework itself. Although there was some work on additional default modules, including an anti-cheating system (wkWormisign) and a Fiddler-like scripted game engine add-on ([[wkMagic]]), none reached a development phase mature enough to be released, and thus the ideas were dropped.

In July 2011, [[WormKitDS]] was released. WormKitDS is an alternative module loader which removes the need of a launcher program. WormKitDS made managing WormKit-requiring replays easier, and worked under Linux and for the Steam edition of the game, whereas the original WormKit did not.

In December 2012, W:A 3.7.0.0 was released, with the addition of an option to load WormKit modules on startup. The new option made the loaders mostly obsolete.

In February 2013, the original WormKit homepage (previously located at http://worms.thecybershadow.net/wormkit/) was shut down and turned into a redirect to this page. The default modules have been made available as separate downloads. The old (obsolete) distribution can still be downloaded [http://worms.thecybershadow.net/wormkit/wormkit.zip here].

== Notes ==

<references/>
__NOTOC__