WormKit

From Worms Knowledge Base

Revision as of 21:44, 17 March 2013 by StepS (Talk | contribs) (applied easy template)

Jump to: navigation, search
(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 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

Name Short description W:A version Developer
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. WormNAT2 Allows hosting games even if you're behind a router or firewall. 3.6.28.0+ CyberShadow
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. FileOverride[1] Override files from the CD-ROM with your versions. All CyberShadow
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. AntiKeyboardHook[1] Stop Worms from disabling Alt+Tab / Win+... keyboard combinations.[2] All CyberShadow
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. SoundCardSelect[1] Choose the soundcard W:A should use for sound output. All CyberShadow
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. D3D9Wnd A Direct3D 9-based windowed mode, which works natively and includes some cool features.
Compatible with both CD and Steam editions of W:A, as well as versions.
3.7.2.1
3.7.0.0
Kawoosh, StepS
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. wkIndiMask It allows maps to have both destructible and indy areas by embedding data in the palette. 3.7.2.1 ▼ Plutonic
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. wkLobbyCmd Allows to change the in-game resolution from a network game lobby to any value. 3.7.2.1 ▼ Kawoosh
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. wkKawooshKick An in-game kicking module, fully compatible with v3.7.2.1, supports the kicking reason. 3.7.2.1 ▼ Kawoosh
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. wkNV3Doff Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9. All Kawoosh
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. wkMapGEN A part of MapGEN, allows to generate random PNG maps from the map editor. All Plutonic
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. wkPointerScan A pointer scan made specifically for W:A. Helpful in the development of new Wormkit modules. All Pisto
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. wkAntiLag A simple module to fix the screen lags in-game by increasing the WA.exe process priority. All Kawoosh
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. wkRandomMap Allows you to download random maps from WMDB directly from the map editor. Undefined ShadowTheAge
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. wkVersionCheck An example on C++ to verify the W:A version before hooking code. All Kawoosh
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. wndmode DirectDraw windowed mode running in a wrapper. All menopem, VEG,
Kawoosh, StepS
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. wkUseDesktopWindow A module which in future will help to run WWP and older W:A on Wine. All Muzer
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. wkSample The example open source module, which shows the development of WormKit modules. All The SCS

Obsolete or incompatible modules

Name Short description W:A version Developer
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. wkColorFix Fixes the color bug on Vista and Windows 7 by suspending an "explorer.exe" process. All CyberShadow
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. wkPathOverride Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files. All Kawoosh
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. RubberWorm Extends the W:A physics engine with new options. 3.7.0.0 ▼ Pisto, Kawoosh
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. ReplayShark Allows to build a directory of nice moments by pressing a button when something cool happens. 3.7.0.0 ▼ Glide
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. wkPrivateCfg Allows you to store all the W:A settings in an INI file instead of registry. 3.7.0.0 ▼ Kawoosh
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. wkRehost Allows you to reopen a lobby of an already played game without quitting W:A and rehosting. [2] 3.7.0.0 ▼ Kawoosh
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. wkPXColorPwnage Fixes the Darker team colour scheme when PX is enabled. 3.6.31.0 Kawoosh
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. FkeyRearrange Allows user to redefine weapons order and content for each F hotkey. 3.6.29-31.0 boobl
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. Localizer Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor. 3.6.31.0 Kawoosh
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. wkKeyRemap A W:A-specific key remapper which doesn't affect chatting and works only in game. 3.6.31.0 Kawoosh
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. Project X Extends W:A with scripting, custom weapons and DirectX 9 rendering. 3.6.31.0 Entuser
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. JetFix Provides a workaround for the jetpack bug when using BattyRope or TestStuff. 3.6.29.0 Pisto
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. 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
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. wkCinusKick An analog to wKick module for W:A update 3.6.29.0. 3.6.29.0 Cinus
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. LaserFix A fix for the Laser Sight desynchronization bug in v3.6.29.0, and some nice features. 3.6.29.0 Pisto

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. 2.0 2.1 This module will not work with the game's "Load WormKit modules" option. A loader (WormKit.exe or WormKitDS) must be used instead.
Personal tools