Difference between revisions of "WormKit"
From Worms Knowledge Base
(→Modules: redefined sections; all current modules are sorted by name; old/incompatible modules are sorted by version) |
|||
Line 17: | Line 17: | ||
== Modules == | == Modules == | ||
+ | |||
+ | === Original modules === | ||
{| | {| | ||
|- | |- | ||
− | ! Name ! | + | ! 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}} | + | | {{WA editions|cd|steam}} |
+ | | 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. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
− | | | + | | All |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| [[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. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | All | ||
| [[People/CyberShadow|CyberShadow]] | | [[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://forum.team17.com/showthread.php?t=62048 D3D9Wnd]''' | | '''[http://forum.team17.com/showthread.php?t=62048 D3D9Wnd]''' | ||
| A Direct3D 9-based windowed mode, which works natively and includes some cool features. | | A Direct3D 9-based windowed mode, which works natively and includes some cool features. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | 3.7.2.1 ▼ | ||
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]] | | [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]] | ||
|- | |- | ||
− | | '''[[wkIndiMask]]''' | + | | '''[[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. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | 3.7.2.1 ▼ | ||
| [[People/Plutonic|Plutonic]] | | [[People/Plutonic|Plutonic]] | ||
|- | |- | ||
− | | '''[[ | + | | '''[[wkKawooshKick|KawooshKick]]''' |
− | | | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason. | | An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | 3.7.2.1 ▼ | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[ | + | | '''[[wkLobbyCmd|LobbyCmd]]''' |
− | | | + | | Allows to change the in-game resolution from a network game lobby to any value. |
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | 3.7.2.1 ▼ | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[[MapGEN | + | | '''[[MapGEN]]''' |
− | | | + | | Allows to generate random PNG maps from the map editor. |
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | All | ||
| [[People/Plutonic|Plutonic]] | | [[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 | |
− | + | ||
− | | '''[http://myfiles.my1.ru/wa/wk/ | + | |
− | | | + | |
− | | {{WA editions|cd|steam}} | + | |
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[[wkRandomMap]]''' | + | | '''[[wkRandomMap|RandomMap]]''' |
| Allows you to download random maps from [[WMDB]] directly from the map editor. | | Allows you to download random maps from [[WMDB]] directly from the map editor. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | Undefined | ||
| [http://shadowtheage.narod.ru ShadowTheAge] | | [http://shadowtheage.narod.ru ShadowTheAge] | ||
|- | |- | ||
− | | '''[ | + | | '''[[wkUseDesktopWindow|UseDesktopWindow]]''' |
− | | | + | | A module which in future will help to run WWP and older W:A on Wine. |
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
− | | [[People/ | + | | All |
+ | | [[People/Muzer|Muzer]] | ||
|- | |- | ||
| '''[http://forum.team17.com/showthread.php?t=57737 wndmode]''' | | '''[http://forum.team17.com/showthread.php?t=57737 wndmode]''' | ||
| DirectDraw windowed mode running in a wrapper. | | DirectDraw windowed mode running in a wrapper. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | All | ||
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]] | | [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]] | ||
+ | |} | ||
+ | |||
+ | |||
+ | === Developer modules, SDKs, debuggers === | ||
+ | |||
+ | {| | ||
|- | |- | ||
− | | '''[[ | + | ! style="width:155px" | Name |
− | | A | + | ! style="width:550px" | Short description |
− | | {{WA editions|cd|steam}}{{ | + | ! style="none" | Com. |
− | | [[People/ | + | ! 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]]''' | | '''[[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. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | All | ||
| [[People/TheSCS|The SCS]] | | [[People/TheSCS|The SCS]] | ||
|} | |} | ||
+ | |||
=== Obsolete or incompatible modules === | === Obsolete or incompatible modules === | ||
Line 112: | Line 166: | ||
{| | {| | ||
|- | |- | ||
− | ! Name ! | + | ! 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 | + | | '''[http://forum.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 an "explorer.exe" process. | ||
− | | {{WA editions|cd|steam}} | + | | {{WA editions|cd|steam}} |
+ | | 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. | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | All | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[[ | + | | '''[[wkPrivateCfg|PrivateCfg]]''' |
− | | | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| 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. | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.7.0.0 ▼ | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[[wkRehost]]''' | + | | '''[[wkRehost|Rehost]]''' |
| Allows you to reopen a lobby of an already played game without quitting W:A and rehosting. <ref name="loader-only" /> | | Allows you to reopen a lobby of an already played game without quitting W:A and rehosting. <ref name="loader-only" /> | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.7.0.0 ▼ | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[ | + | | '''[[ReplayShark]]''' |
− | | | + | | Allows to build a directory of nice moments by pressing a button when something cool happens. |
− | | {{WA editions|cd}}{{ | + | | {{WA editions|cd}} |
− | | [[People/Kawoosh|Kawoosh]] | + | | 3.7.0.0 ▼ |
+ | | [[People/Glide|Glide]] | ||
+ | |- | ||
+ | | '''[[RubberWorm]]''' | ||
+ | | Extends the W:A physics engine with new options. | ||
+ | | {{WA editions|cd}} | ||
+ | | 3.7.0.0 ▼ | ||
+ | | [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
| '''[[FkeyRearrange]]''' | | '''[[FkeyRearrange]]''' | ||
| Allows user to redefine weapons order and content for each F hotkey. | | Allows user to redefine weapons order and content for each F hotkey. | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.6.31.0 ▼ | ||
| [[People/boobl|boobl]] | | [[People/boobl|boobl]] | ||
|- | |- | ||
− | | '''[[ | + | | '''[[wkKeyRemap|KeyRemap]]''' |
− | | | + | | A W:A-specific key remapper which doesn't affect chatting and works only in game. |
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.6.31.0 | ||
| [[People/Kawoosh|Kawoosh]] | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | | '''[[ | + | | '''[[WA_Localizer|Localizer]]''' |
− | | | + | | Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor. |
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.6.31.0 | ||
| [[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. | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.6.31.0 | ||
| [http://px.worms2d.info Entuser] | | [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}} | + | | {{WA editions|cd}} |
− | | [[People/ | + | | 3.6.31.0 |
+ | | [[People/Kawoosh|Kawoosh]] | ||
|- | |- | ||
− | + | | '''[http://worms.cinus.org/wkcinuskick CinusKick]''' | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | | '''[http://worms.cinus.org/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. | ||
− | | {{WA editions|cd}} | + | | {{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. | ||
− | | {{WA editions|cd}}{{ | + | | {{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]] | | [[People/Pisto|Pisto]] | ||
|- | |- | ||
| '''[[wkMagic]]''' | | '''[[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. | ||
− | | {{WA editions|cd}} | + | | {{WA editions|cd}} |
+ | | 3.6.26.5 | ||
| [[People/CyberShadow|CyberShadow]] | | [[People/CyberShadow|CyberShadow]] | ||
|} | |} |
Revision as of 11:12, 19 March 2013
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 letter "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 | Com. | W:A version | Developer |
---|---|---|---|---|
AntiKeyboardHook[1] | Stop Worms from disabling Alt+Tab / Win+... keyboard combinations.[2] | All | CyberShadow | |
FileOverride[1] | Override files from the CD-ROM with your versions. | All | CyberShadow | |
SoundCardSelect[1] | Choose the soundcard W:A should use for sound output. | All | CyberShadow | |
WormNAT2 | Allows hosting games even if you're behind a router or firewall. | 3.6.28.0+ | CyberShadow |
Current modules by community
Name | Short description | Com. | W:A version | Developer |
---|---|---|---|---|
AntiLag | A simple module to fix the screen lags in-game by increasing the WA.exe process priority. | All | Kawoosh | |
D3D9Wnd | A Direct3D 9-based windowed mode, which works natively and includes some cool features. | 3.7.2.1 ▼ | Kawoosh, StepS | |
IndiMask | It allows maps to have both destructible and indy areas by embedding data in the palette. | 3.7.2.1 ▼ | Plutonic | |
KawooshKick | An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason. | 3.7.2.1 ▼ | Kawoosh | |
LobbyCmd | Allows to change the in-game resolution from a network game lobby to any value. | 3.7.2.1 ▼ | Kawoosh | |
MapGEN | Allows to generate random PNG maps from the map editor. | All | Plutonic | |
NV3Doff | Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9. | All | Kawoosh | |
RandomMap | Allows you to download random maps from WMDB directly from the map editor. | Undefined | ShadowTheAge | |
UseDesktopWindow | A module which in future will help to run WWP and older W:A on Wine. | All | Muzer | |
wndmode | DirectDraw windowed mode running in a wrapper. | All | menopem, VEG, Kawoosh, StepS |
Developer modules, SDKs, debuggers
Name | Short description | Com. | W:A version | Developer |
---|---|---|---|---|
MinidumpOnCtrlBreak | Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break. | All | CyberShadow | |
PointerScan | A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules. | All | Pisto | |
VersionCheck | An example on C++ to verify the W:A version before hooking code. | All | Kawoosh | |
wkSample | The example open source module, which shows the development of WormKit modules. | All | The SCS |
Obsolete or incompatible modules
Name | Short description | Com. | W:A version | Developer |
---|---|---|---|---|
ColorFix | Fixes the color bug on Vista and Windows 7 by suspending an "explorer.exe" process. | All | CyberShadow | |
PathOverride | Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files. | All | Kawoosh | |
PrivateCfg | Allows you to store all the W:A settings in an INI file instead of registry. | 3.7.0.0 ▼ | Kawoosh | |
Rehost | Allows you to reopen a lobby of an already played game without quitting W:A and rehosting. [2] | 3.7.0.0 ▼ | Kawoosh | |
ReplayShark | Allows to build a directory of nice moments by pressing a button when something cool happens. | 3.7.0.0 ▼ | Glide | |
RubberWorm | Extends the W:A physics engine with new options. | 3.7.0.0 ▼ | Pisto, Kawoosh | |
FkeyRearrange | Allows user to redefine weapons order and content for each F hotkey. | 3.6.31.0 ▼ | boobl | |
KeyRemap | A W:A-specific key remapper which doesn't affect chatting and works only in game. | 3.6.31.0 | Kawoosh | |
Localizer | Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor. | 3.6.31.0 | Kawoosh | |
Project X | Extends W:A with scripting, custom weapons and DirectX 9 rendering. | 3.6.31.0 | Entuser | |
PXColorPwnage | Fixes the Darker team colour scheme when PX is enabled. | 3.6.31.0 | Kawoosh | |
CinusKick | An analog to wKick module for W:A update 3.6.29.0. | 3.6.29.0 | Cinus | |
JetFix | Provides a workaround for the jetpack bug when using BattyRope or TestStuff. | 3.6.29.0 | Pisto | |
LaserFix | A fix for the Laser Sight desynchronization bug in v3.6.29.0, and some nice features. | 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. | 3.6.28.0 | Pisto | |
wkMagic | First proof-of-concept module that allowed game logic code modification in online games. | 3.6.26.5 | CyberShadow |
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.