Difference between revisions of "WormKit"

From Worms Knowledge Base

Jump to: navigation, search
(Obsolete or incompatible modules: Add wkMagic)
(Current modules by community: Updates to D3D9Wnd)
 
(44 intermediate revisions by 7 users not shown)
Line 12: Line 12:
 
'''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.
 
'''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 letter "wk". There is no API or further integration, however some DLLs can provide common functionality for other modules to share (such as wkPackets).
+
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.
 
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 ==
 
== Modules ==
 +
 +
=== Original modules ===
  
 
{|
 
{|
 
|-
 
|-
! Name !! Short description !! For W:A version !! Developer
+
! style="width:164px" | Name
 +
! style="none" | Short description
 +
! style="width:68px" | Compat.
 +
! style="width:100px" | W:A version
 +
! style="none" | Developer
 
|-
 
|-
| '''[[WormNAT2]]'''
+
| '''[http://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" />
| Allows hosting games even if you're behind a router or firewall.
+
| Stop MS Windows from disabling Alt+Tab / Win+... keyboard combinations for wa.exe.<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>
| <font color="green">3.6.28.0+</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/CyberShadow|CyberShadow]]
 
| [[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>
 
| '''[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.
 
| Override files from the CD-ROM with your versions.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
| [[People/CyberShadow|CyberShadow]]
+
| All
|-
+
| '''[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>
+
| <font color="green">All</font>
+
 
| [[People/CyberShadow|CyberShadow]]
 
| [[People/CyberShadow|CyberShadow]]
 
|-
 
|-
 
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" />
 
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" />
 
| Choose the soundcard W:A should use for sound output.
 
| Choose the soundcard W:A should use for sound output.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/CyberShadow|CyberShadow]]
 
| [[People/CyberShadow|CyberShadow]]
 
|-
 
|-
| '''[http://forum.team17.com/showthread.php?t=62048 D3D9Wnd]'''
+
| '''[[WormNAT2]]'''
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br>Compatible with both CD and Steam editions of W:A, as well as versions.
+
| Allows hosting games even if you're behind a router or firewall.
| <font color="green">3.7.2.1 (Both)</font><br><font color="green">3.7.0.0</font>
+
| {{WA editions|cd|steam|gog}}
 +
| 3.6.28.0+
 +
| [[People/CyberShadow|CyberShadow]]
 +
|}
 +
 
 +
=== Current modules by community ===
 +
 
 +
{|
 +
|-
 +
! style="width:164px" | Name
 +
! style="none" | Short description
 +
! style="width:68px" | Compat.
 +
! style="width:100px" | W:A version
 +
! style="none" | Developer
 +
|-
 +
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''
 +
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/Kawoosh|Kawoosh]]
 +
|-
 +
| '''[[wkBindKeys|BindKeys]]'''
 +
| A key mapper which works independently of the game's code and has a toggle key option.
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/Drey08|drey08]]
 +
|-
 +
| '''[https://www.tus-wa.com/?topic=19063 D3D9Wnd]'''
 +
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.
 +
| {{WA editions|cd|steam|gog}}
 +
| 3.7+
 
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
 
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
 
|-
 
|-
| '''[[wkIndiMask]]'''
+
| '''[[FkeyRearrange]]'''
 +
| Allows the user to redefine the order and content of weapons for each F hotkey.
 +
| {{WA editions|cd|steam|gog}}
 +
| 3.7.2.1 {{and lower}}
 +
| [[People/boobl|boobl]], [[People/StepS|StepS]]
 +
|-
 +
| '''[[wkIndiMask|IndiMask]]'''
 
| It allows maps to have both destructible and indy areas by embedding data in the palette.
 
| It allows maps to have both destructible and indy areas by embedding data in the palette.
| <font color="green">3.7.2.1 (Both) ▼</font>
+
| {{WA editions|cd|steam|gog}}
 +
| 3.7.2.1 {{and lower}}
 
| [[People/Plutonic|Plutonic]]
 
| [[People/Plutonic|Plutonic]]
 
|-
 
|-
| '''[[wkLobbyCmd]]'''
+
| '''[[wkKawooshKick|KawooshKick]]'''
| Allows to change the in-game resolution from a network game lobby to any value.
+
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.
| <font color="green">3.7.2.1 (Both) ▼</font>
+
| {{WA editions|cd|steam}}
 +
| 3.7.2.1 {{and lower}}
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[[wkKawooshKick]]'''
+
| '''[[wkLobbyCmd|LobbyCmd]]'''
| An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason.
+
| Allows to change the in-game resolution from a network game lobby to any value.
| <font color="green">3.7.2.1 (Both) ▼</font>
+
| {{WA editions|cd|steam}}
 +
| 3.7.2.1 {{and lower}}
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[http://myfiles.my1.ru/wa/wk/wkNV3Doff.dll wkNV3Doff]'''
+
| '''[[MapGEN]]'''
 +
| Allows to generate random PNG maps from the map editor.
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/Plutonic|Plutonic]]
 +
|-
 +
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''
 
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.
 
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[[MapGEN|wkMapGEN]]'''
+
| '''[[wkRehost|Rehost]]'''
| A part of [[MapGEN]], allows to generate random PNG maps from the map editor.
+
| Allows reopening games when using a snooper to host.
| <font color="green">All</font>
+
| {{WA editions|cd}}
| [[People/Plutonic|Plutonic]]
+
| 3.7.2.1 {{and lower}}
 +
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[[wkPointerScan]]'''
+
| '''[[wkRemapKeys|RemapKeys]]'''
| A pointer scan made specifically for W:A. Helpful in the development of new Wormkit modules.
+
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
| [[People/Pisto|Pisto]]
+
| 3.7+
 +
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
 
|-
 
|-
| '''[http://myfiles.my1.ru/wa/wk/wkAntiLag.dll wkAntiLag]'''
+
| '''[[ReplayShark]]'''
| A simple module to fix the screen lags in-game by increasing the WA.exe process priority.
+
| Allows to build a catalog of nice moments by pressing a button when something cool happens.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
| [[People/Kawoosh|Kawoosh]]
+
| 3.7.2.1 {{and lower}}
 +
| [[People/Glide|Glide]]
 
|-
 
|-
| '''[[wkRandomMap]]'''
+
| '''[[RubberWorm]]'''
| Allows you to download random maps from [[WMDB]] directly from the map editor.
+
| Extends the W:A physics engine with new options.
| <font color="#99CC33">Undefined</font>
+
| {{WA editions|cd|steam}}
| [http://shadowtheage.narod.ru ShadowTheAge]
+
| 3.7.2.1 {{and lower}}
 +
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[http://myfiles.my1.ru/wa/wk/wkVersionCheck.zip wkVersionCheck]'''
+
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''
| An example on C++ to verify the W:A version before hooking code.
+
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.
| <font color="green">All</font>
+
| {{WA editions|cd|steam}}
| [[People/Kawoosh|Kawoosh]]
+
| 3.7.2.1 {{and lower}}
 +
| [[People/StepS|StepS]]
 
|-
 
|-
| '''[http://forum.team17.com/showthread.php?t=57737 wndmode]'''
+
| '''[[SuperFrontendHD]]'''
| DirectDraw windowed mode running in a wrapper.
+
| Allows to run the frontend at any resolution and helps people without 640x480 support.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
+
| 3.7+
 +
| [[People/StepS|StepS]]
 
|-
 
|-
| '''[[wkUseDesktopWindow]]'''
+
| '''[http://www.tus-wa.com/?topic=29504 Terrain]'''
 +
| Allows to specify custom terrains for use with the map generator.
 +
| {{WA editions|cd|steam}}
 +
| 3.7.2.1
 +
| [[People/xKoweKx|xKoweKx]]
 +
|-
 +
| '''[[TrackMeBetter]]'''
 +
| Allows to tune the in-game camera tracking rectangle for object motion.
 +
| {{WA editions|cd|steam|gog}}
 +
| 3.7.2.1
 +
| [[People/StepS|StepS]]
 +
|-
 +
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''
 
| A module which in future will help to run WWP and older W:A on Wine.
 
| A module which in future will help to run WWP and older W:A on Wine.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/Muzer|Muzer]]
 
| [[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|gog}}
 +
| All
 +
| [[People/Plutonic|Plutonic]]
 +
|-
 +
| '''[http://beta.team17.com/showthread.php?t=57737 wndmode]'''
 +
| DirectDraw windowed mode running in a wrapper.
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]
 +
|}
 +
 +
=== Developer modules, SDKs, debuggers ===
 +
 +
{|
 +
|-
 +
! style="width:164px" | Name
 +
! style="none" | Short description
 +
! style="width:68px" | Compat.
 +
! style="width:100px" | W:A version
 +
! style="none" | Developer
 +
|-
 +
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''
 +
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/StepS|StepS]]
 +
|-
 +
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''
 +
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.
 +
| {{WA editions|cd|steam|gog}}
 +
| 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}}
 +
| 3.6.31.0 {{and lower}}
 +
| [[People/Pisto|Pisto]]
 +
|-
 +
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''
 +
| An example on C++ to verify the W:A version before hooking code.
 +
| {{WA editions|cd|steam|gog}}
 +
| All
 +
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
 
| '''[[wkSample]]'''
 
| '''[[wkSample]]'''
 
| The example open source module, which shows the development of WormKit modules.
 
| The example open source module, which shows the development of WormKit modules.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/TheSCS|The SCS]]
 
| [[People/TheSCS|The SCS]]
 
|}
 
|}
Line 112: Line 229:
 
{|
 
{|
 
|-
 
|-
! Name !! Short description !! For W:A version !! Developer
+
! style="width:164px" | Name
 +
! style="none" | Short description
 +
! style="width:68px" | Compat.
 +
! style="width:100px" | W:A version
 +
! style="none" | Developer
 
|-
 
|-
| '''[http://forum.team17.com/showthread.php?t=38762 wkColorFix]'''
+
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''
| Fixes the color bug on Vista and Windows 7 by suspending an "explorer.exe" process.
+
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.
| <font color="green">All</font>
+
| {{WA editions|cd|steam|gog}}
 +
| All
 
| [[People/CyberShadow|CyberShadow]]
 
| [[People/CyberShadow|CyberShadow]]
 
|-
 
|-
| '''[[wkPathOverride]]'''
+
| '''[[wkPathOverride|PathOverride]]'''
 
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.
 
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.
| <font color="green">All</font>
+
| {{WA editions|cd}}
 +
| All
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[[RubberWorm]]'''
+
| '''[[wkRandomMap|RandomMap]]'''
| Extends the W:A physics engine with new options.
+
| Allows you to download random maps from [[WMDB]] directly from the map editor.
| <font color="red">3.7.0.0 </font>
+
| {{WA editions|cd}}
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]
+
| Undefined<ref name="bad">After the 3.7.0.0 update, wkRandomMap has stopped working on some systems, but it is unknown what makes it malfunction on any particular system. This module is now deprecated; wkWMDB is preferable.</ref>
 +
| [http://shadowtheage.narod.ru ShadowTheAge]
 
|-
 
|-
| '''[[ReplayShark]]'''
+
| '''[[wkPrivateCfg|PrivateCfg]]'''
| Allows to build a directory of nice moments by pressing a button when something cool happens.
+
| <font color="red">3.7.0.0 ▼</font>
+
| [[People/Glide|Glide]]
+
|-
+
| '''[[wkPrivateCfg]]'''
+
 
| Allows you to store all the W:A settings in an INI file instead of registry.
 
| Allows you to store all the W:A settings in an INI file instead of registry.
| <font color="red">3.7.0.0 ▼</font>
+
| {{WA editions|cd}}
 +
| 3.7.0.0 {{and lower}}
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
|-
 
| '''[[wkRehost]]'''
 
| Allows you to reopen a lobby of an already played game without quitting W:A and rehosting. <ref name="loader-only" />
 
| <font color="red">3.7.0.0 ▼</font>
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll wkPXColorPwnage]'''
 
| Fixes the Darker team colour scheme when PX is enabled.
 
| <font color="red">3.6.31.0</font>
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
| '''[[FkeyRearrange]]'''
 
| Allows user to redefine weapons order and content for each F hotkey.
 
| <font color="red">3.6.29-31.0</font>
 
| [[People/boobl|boobl]]
 
 
|-
 
|-
 
| '''[[WA_Localizer|Localizer]]'''
 
| '''[[WA_Localizer|Localizer]]'''
 
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.
 
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.
| <font color="red">3.6.31.0</font>
+
| {{WA editions|cd}}
| [[People/Kawoosh|Kawoosh]]
+
| 3.6.31.0
|-
+
| '''[[wkKeyRemap]]'''
+
| A W:A-specific key remapper which doesn't affect chatting and works only in game.
+
| <font color="red">3.6.31.0</font>
+
 
| [[People/Kawoosh|Kawoosh]]
 
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
 
| '''[[Project X]]'''
 
| '''[[Project X]]'''
 
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.
 
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.
| <font color="red">3.6.31.0</font>
+
| {{WA editions|cd}}
 +
| 3.6.31.0
 
| [http://px.worms2d.info Entuser]
 
| [http://px.worms2d.info Entuser]
 
|-
 
|-
| '''[[JetFix]]'''
+
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].
+
| Fixes the Darker team colour scheme when PX is enabled.
| <font color="red">3.6.29.0</font>
+
| {{WA editions|cd}}
| [[People/Pisto|Pisto]]
+
| 3.6.31.0
 +
| [[People/Kawoosh|Kawoosh]]
 
|-
 
|-
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''
+
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.
+
| <font color="red">3.6.28.0</font>
+
| [[People/Pisto|Pisto]]
+
|-
+
| '''[http://worms.cinus.org/wkcinuskick wkCinusKick]'''
+
 
| An analog to wKick module for W:A update 3.6.29.0.
 
| An analog to wKick module for W:A update 3.6.29.0.
| <font color="red">3.6.29.0</font>
+
| {{WA editions|cd}}
 +
| 3.6.29.0
 
| [http://worms.cinus.org Cinus]
 
| [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]]'''
 
| '''[[LaserFix]]'''
 
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.
 
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.
| <font color="red">3.6.29.0</font>
+
| {{WA editions|cd}}
 +
| 3.6.29.0
 
| [[People/Pisto|Pisto]]
 
| [[People/Pisto|Pisto]]
 
|-
 
|-
| '''[[[wkMagic]]'''
+
| '''[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.
 
| First proof-of-concept module that allowed game logic code modification in online games.
| <font color="red">3.6.26.5</font>
+
| {{WA editions|cd}}
 +
| 3.6.26.5
 
| [[People/CyberShadow|CyberShadow]]
 
| [[People/CyberShadow|CyberShadow]]
 +
|}
 +
 +
=== Non-W:A modules ===
 +
 +
{|
 +
|-
 +
! style="width:164px" | Name
 +
! style="none" | Short description
 +
! style="width:68px" | Compat.
 +
! style="width:100px" | W:A version
 +
! style="none" | Developer
 +
|-
 +
| '''[[ReSolution]]'''
 +
| Allows to change the in-game resolution in Worms 2 and Worms World Party to any value, as well as zoom and resize the game environment.
 +
| {{software|W2|WWP}}
 +
| 1.05 (W2)<br>1.0x (WWP)
 +
| [[People/StepS|StepS]]
 +
|-
 +
| '''[[DDShot]]'''
 +
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).
 +
| {{software|W2|WWP|WA}}
 +
| All
 +
| [[People/StepS|StepS]]
 +
|-
 +
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''
 +
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.
 +
| {{software|W2}}
 +
| All
 +
| See "wndmode"
 +
|-
 +
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''
 +
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.
 +
| {{software|WWP}}
 +
| All
 +
| See "wndmode"
 
|}
 
|}
  

Latest revision as of 00:52, 6 July 2017

(Up to Software)
icon WormKit
Developer: CyberShadow
Supported games: W:A
Supported W:A version: All versions
Language: Delphi
License: Open-source[1]

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

Name Short description Compat. W:A version Developer
AntiKeyboardHook[1] Stop MS Windows from disabling Alt+Tab / Win+... keyboard combinations for wa.exe.[2] This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All CyberShadow
FileOverride[1] Override files from the CD-ROM with your versions. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All CyberShadow
SoundCardSelect[1] Choose the soundcard W:A should use for sound output. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All CyberShadow
WormNAT2 Allows hosting games even if you're behind a router or firewall. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.6.28.0+ CyberShadow

Current modules by community

Name Short description Compat. W:A version Developer
AntiLag A simple module to fix screen lags in-game by increasing the WA.exe process priority. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Kawoosh
BindKeys A key mapper which works independently of the game's code and has a toggle key option. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All drey08
D3D9Wnd A Direct3D 9-based windowed mode, which works natively and includes some cool features. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7+ Kawoosh, StepS
FkeyRearrange Allows the user to redefine the order and content of weapons for each F hotkey. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7.2.1 boobl, StepS
IndiMask It allows maps to have both destructible and indy areas by embedding data in the palette. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7.2.1 Plutonic
KawooshKick An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 Kawoosh
LobbyCmd Allows to change the in-game resolution from a network game lobby to any value. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 Kawoosh
MapGEN Allows to generate random PNG maps from the map editor. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Plutonic
NV3Doff Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Kawoosh
Rehost Allows reopening games when using a snooper to host. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 Kawoosh
RemapKeys A W:A-specific key remapper which doesn't affect chatting and works in-game only. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7+ Kawoosh, StepS
ReplayShark Allows to build a catalog of nice moments by pressing a button when something cool happens. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7.2.1 Glide
RubberWorm Extends the W:A physics engine with new options. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 Pisto, Kawoosh
Snow A module to enable, customize and/or disable snow anytime, doesn't affect map generation. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 StepS
SuperFrontendHD Allows to run the frontend at any resolution and helps people without 640x480 support. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7+ StepS
Terrain Allows to specify custom terrains for use with the map generator. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.2.1 xKoweKx
TrackMeBetter Allows to tune the in-game camera tracking rectangle for object motion. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. 3.7.2.1 StepS
UseDesktopWindow A module which in future will help to run WWP and older W:A on Wine. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Muzer
wkWMDB Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Plutonic
wndmode DirectDraw windowed mode running in a wrapper. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All menopem, VEG,
Kawoosh, StepS

Developer modules, SDKs, debuggers

Name Short description Compat. W:A version Developer
DetectFocusLoss Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations) This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All StepS
MinidumpOnCtrlBreak Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All CyberShadow
PointerScan A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.31.0 Pisto
VersionCheck An example on C++ to verify the W:A version before hooking code. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All Kawoosh
wkSample The example open source module, which shows the development of WormKit modules. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All The SCS

Obsolete or incompatible modules

Name Short description Compat. W:A version Developer
ColorFix Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process. This item is compatible with the CD edition of W:A.  This item is compatible with the Steam edition of W:A.This item is compatible with the GOG edition of W:A. All CyberShadow
PathOverride Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. All Kawoosh
RandomMap Allows you to download random maps from WMDB directly from the map editor. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. Undefined[3] ShadowTheAge
PrivateCfg Allows you to store all the W:A settings in an INI file instead of registry. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.7.0.0 Kawoosh
Localizer Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.31.0 Kawoosh
Project X Extends W:A with scripting, custom weapons and DirectX 9 rendering. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.31.0 Entuser
PXColorPwnage Fixes the Darker team colour scheme when PX is enabled. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.31.0 Kawoosh
CinusKick An analog to wKick module for W:A update 3.6.29.0. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.29.0 Cinus
JetFix Provides a workaround for the jetpack bug when using BattyRope or TestStuff. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.29.0 Pisto
LaserFix A fix for the Laser Sight desynchronization bug in v3.6.29.0, and some nice features. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.29.0 Pisto
wKick Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.28.0 Pisto
wkMagic First proof-of-concept module that allowed game logic code modification in online games. This item is compatible with the CD edition of W:A.  This item is not compatible with the Steam edition of W:A.This item is not compatible with the GOG edition of W:A. 3.6.26.5 CyberShadow

Non-W:A modules

Name Short description Compat. W:A version Developer
ReSolution Allows to change the in-game resolution in Worms 2 and Worms World Party to any value, as well as zoom and resize the game environment. [W2][—][WWP] 1.05 (W2)
1.0x (WWP)
StepS
DDShot Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause). [W2][WA][WWP] All StepS
W2 Windowed Mode Allows to run Worms 2 in a window and fixes Windows 8+ performance issues. [W2][—][—] All See "wndmode"
WWP Windowed Mode Fixes compatibility with all modern systems and drivers and allows to use windowed mode. [—][—][WWP] All See "wndmode"

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 here.

Notes

  1. 1.0 1.1 1.2 1.3 Source code for WormKit and default modules can be found on GitHub.
  2. This module will not work with the game's "Load WormKit modules" option. A loader (WormKit.exe or WormKitDS) must be used instead.
  3. After the 3.7.0.0 update, wkRandomMap has stopped working on some systems, but it is unknown what makes it malfunction on any particular system. This module is now deprecated; wkWMDB is preferable.
Personal tools