https://worms2d.info/api.php?action=feedcontributions&user=Kobaryo&feedformat=atomWorms Knowledge Base - User contributions [en]2024-03-29T00:07:48ZUser contributionsMediaWiki 1.26.3https://worms2d.info/?title=WkToolAssist&diff=31467WkToolAssist2023-01-04T17:10:08Z<p>Kobaryo: updated download mirror</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkToolAssist<br />
| developer = [[nizikawa]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.1<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| license = Closed-source<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wktoolassist-v-0-1-0-released-33517/ TUS Page]<br />
| download = [https://github.com/nizikawa-worms/wkToolAssist/releases/download/v.0.1.0/wkToolAssist.v.0.1.0.zip wkToolAssist v. 0.1.0 (13.2 MB)]<br />
}}<br />
<br />
This [[WormKit]] that implements some features present in Tool Assisted WA Builds by Deadcode.<br />
<br />
== Features ==<br />
* Adjust game speed at any time<br />
* Set checkpoints to rollback game state<br />
* Step frame forward/backward<br />
* Show trajectories of moving worms, projectiles and mines<br />
* Record .wagame replays in a format compatible with stock WA<br />
<br />
== Limitations ==<br />
* To prevent abuse, the module comes bundled with a special version of WA.exe with disabled network functionality. The module is closed source.<br />
* Version 0.1.0 lacks the ability to edit existing replays. This feature is planned for version 0.2.0<br />
* Recorded replays contain chat message about wkToolAssist being used<br />
* Team flags are replaced with "TA" flag<br />
<br />
== Installation ==<br />
# Extract ToolAssist.dll and TA_*.exe matching your WA version to your Worms Armageddon installation directory<br />
# Launch TA_*.exe<br />
<br />
== Controls ==<br />
* Keys 0-9 - set game speed to predefined values:<br />
1: 1.0x,<br />
2: 0.5x,<br />
3: 0.25x<br />
4: 0.15x<br />
5: 0.1x<br />
6: 0.05x<br />
7: 0.025x<br />
8: 0.0125x<br />
9: 0.005x<br />
0: stop time<br />
* Keys + - increase/decrease game speed by 0.01x<br />
* Keys [ ] step a single frame backward/forward<br />
* Key S - save current frame as checkpoint<br />
* Key R - restore game state to the last checkpoint<br />
* Key Z - remove last checkpoint and restore state to the previous one<br />
* Key ~ - revert game to frame 0 and start playing until the last checkpoint<br />
<br />
== Notes on keyboard inputs ==<br />
* Game controls in stock WA are buggy at game speeds 0.25x and below. To fix this problem the module implements it's own keyboard handling logic and uses it at speeds <= 0.25x<br />
* The custom key logic does not respect custom mappings used in wkRemapKeys<br />
* Some keys such as space or enter are set as sticky - pressing them once remembers the state until the next time the key state is read by the game, usually on the next logic frame.<br />
* To "unpress" sticky key, hold shift and press the keyboard key you want to unpress.<br />
* The list of active keys is displayed in the screen corner</div>Kobaryohttps://worms2d.info/?title=TrackMeBetter&diff=31388TrackMeBetter2022-10-30T08:07:29Z<p>Kobaryo: Added info about wkTrackMeBetter381</p>
<hr />
<div>{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTrackMeBetter<br />
| developer = [[People/StepS|StepS]] <br />
| version = 0.0.1.7 / 15 January 2017<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.7.2.1<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C<br />
| website = [http://www.tus-wa.com/?topic=30442 TUS forum]<br />
| download = [https://steps.keybase.pub/wa/wk/wkTrackMeBetter.zip TrackMeBetter 0.0.1.7 (2.24 kB)]<br />
}}<br />
<br />
{{Software_infobox<br />
| name = wkTrackMeBetter381<br />
| developer = [[People/nizikawa|nizikawa]] <br />
| version = 1.0.0.0 / 15 September 2022<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.1.0<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkTrackMeBetter381 GitHub repository]<br />
| download = [https://github.com/nizikawa-worms/wkTrackMeBetter381/releases/latest/download/wkTrackMeBetter381-release.zip wkTrackMeBetter381 1.0.0.0]<br />
}}<br />
<br />
This [[WormKit]] module allows you to change the size of the in-game camera tracking box for object motion (such as worms, grenades, and the mouse cursor).<br />
<br />
The original version, wkTrackMeBetter developed by [[People/StepS|StepS]] supports WA 3.7.2.1. The module was reimplemented by [[People/nizikawa|nizikawa]] as wkTrackMeBetter381 to support WA 3.8.1.0.<br />
<br />
== How to use it ==<br />
First of all, you need to have the "Load WormKit modules" option from Advanced settings enabled. Unpack the files into your W:A folder.<br />
<br />
Options are stored in the '''wkTrackMeBetter.ini''' file. The ''ConfinementPercentage'' option lets you specify the relative size (in percents) of the camera box. Only the following values are supported at the moment:<br />
* 200 - makes the camera box cover the whole screen (2x larger than the default). The camera will only move when a given object reaches the edge of the screen. This is ScrollLock-like.<br />
* 100 - the default (1/2 of the screen, like in the original game).<br />
* 50 - 1/4 of the screen.</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=31387WormKit2022-10-30T08:01:19Z<p>Kobaryo: Moved wkTrackMeBetter to compatible modules</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMaps]]'''<br />
| Picks random maps from SavedLevels folder.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/Masta|Masta]]<br />
|-<br />
| '''[[wkRealTime]]'''<br />
| Real-time online multiplayer for racing schemes.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTextMacros]]'''<br />
| Implements automatic text macros in both lobby and in-game chat.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[[wkToolAssist]]'''<br />
| Adds Tool Assisted features - playing the game in super slow motion or frame by frame, saving and restoring game state, showing roping trajectory<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1, 3.8.1<br />
| [[People/StepS|StepS]],[[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkWormOrder]]'''<br />
| Appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=30188WkTerrainSync2022-01-05T18:41:00Z<p>Kobaryo: v. 1.2.4</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.4 (5 January 2022)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/wormkit-modules/wkterrainsync-v-1-2-4-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/wormkit-modules/wkterrainsync-v-1-2-4-released-play-custom-missions-online-33098/?action=dlattach;attach=198858]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]. It supports online multiplayer (providing all players have the module installed) and will automatically download the custom terrain from the host if it doesn't exist locally.<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA. A full list of community-made [[WkTerrainSync#Custom_terrains|Custom Terrains]] can be found below.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
Those using the CD version of WA however, will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip wkFileOverride] to use the module.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Playing on custom terrains with those who do no have the module is possible by first converting the map to PNG. However, the debris, soil, background, custom water and other features of the terrain will be lost.<br><br />
To convert the map to PNG format:<br><br />
* Enter the detailed map settings window by right clicking the map in the lobby.<br />
* If not already in preview mode, click the preview terrain button [[Image:PreviewTerrainButton.png|inline|24px|Preview terrain button]].<br />
* Right-click the return to edit mode button [[Image:TerrainButton.png|inline|24px|Return to edit mode button]]. The map will now be a PNG map.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission /<br>Last update<br />
<br />
|-<br />
| Arachnophobia || [[People/Conejo|Conejo]], [[People/sbs|sbs]] || [https://www.tus-wa.com/files/file-2230/ TUS file] || Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027 || 2020-12-31<br />
|-<br />
| Arcade || [[People/Ducky|Ducky]] || [https://www.tus-wa.com/files/file-2252/ TUS file] || Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object || 2021-01-24<br />
|-<br />
| Berlin Boss|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2444/ TUS file] || Made with Assets from the WWP's Berlin Boss map || 2021-12-21<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Camping || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2258/ TUS file] || || 2021-08-17<br />
|-<br />
| Candy || unknown || [https://www.tus-wa.com/files/file-2262/ TUS file] || created using [[MapGEN]] Candy theme || 2018<br />
|-<br />
| Cars|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2447/ TUS file] || Made with Assets from the WA's Cars map || 2021-12-22<br />
|-<br />
| Chateau|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2450/ TUS file] || Made with Assets from the WA's Chateau map || 2021-12-27<br />
|-<br />
| Chocolate || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2348/ TUS file] || || 2021-11-06<br />
|-<br />
| Cosmic || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2208/ TUS file] || || 2021-11-02<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Dinos || [[Team17]] || [https://www.tus-wa.com/files/file-1276/ TUS file] || Imported from WWP || 2018<br />
|-<br />
| DIY || [[Team17]] || [https://www.tus-wa.com/files/file-2254/ TUS file] || Imported from Worms DC by [[People/Ducky|Ducky]] || 2020-09-01<br />
|-<br />
| Domestic || [[Team17]] || [https://www.tus-wa.com/files/file-1276/ TUS file] || Imported from WWP || 2018<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]], [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Electronics || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2213/ TUS file] || || 2020-12-05<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Fruit Bastilles|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2452/ TUS file] || Made with Assets from the WWP's Fruit Bastilles map || 2021-12-28<br />
|-<br />
| Ganja || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2162/ TUS file] || || 2021-08-17<br />
|-<br />
| Halloween || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2415/ TUS file] || || 2021-10-23<br />
|-<br />
| Island Antics|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2448/ TUS file] || Made with Assets from the WWP's Island Antics map || 2021-12-24<br />
|-<br />
| Lowpoly || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2234/ TUS file] || || 2021-01-06<br />
|-<br />
| Missile Base|| [[JSG]], [[Team17]] || [https://www.tus-wa.com/files/file-2444/ TUS file] || Made with Assets from the WWP's Missile Base map || 2021-12-30<br />
|-<br />
| Mulheresbarbadas || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2322/ TUS file] || Art from https://mulheresbarbadas.tumblr.com/ || 2021-06-03<br />
|-<br />
| Origami || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2214/ TUS file] || || 2020-12-05<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Sushi || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2333 TUS file] || || 2021-06-07<br />
|-<br />
| Tetris || [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2261/ TUS file] || || 2016-06-28<br />
|-<br />
| Win95 || [[People/Ducky|Ducky]] || [https://www.tus-wa.com/files/file-2253/ TUS file] || || 2020-09-01<br />
|-<br />
| Worms: A Space Oddity terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2399/ TUS file] || Contains: Cavernia, Earth, Frostal, Kaputzol, Mechanopolis, Tenticilia || 2021-09-12<br />
|-<br />
| Worms: Battle Islands terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2405/ TUS file] || Contains: Area 51, Chemical, Jungle, Nuclear, Polar, Underwater || 2021-09-19<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms Revolution terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2391/ TUS file] || Contains: Beach, Farm, Junkyard, Sewer, Spooky || 2021-09-10<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
A combined pack that has everything mentioned above as of 2021-09-14 is available [https://cdn.discordapp.com/attachments/416225356706480130/887420782760841256/terrains.rar here].<br><br />
It was posted on [[People/Sensei|Sensei's]] Discord [https://discord.gg/UBRBhk6 server] in [https://discord.com/channels/416225356706480128/416225356706480130/887420783465463808 this message].<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''|link=Media:Arcade_large.png<br />
<br />
File:BerlinBoss_small.png|'''Berlin Boss'''|link=Media:BerlinBoss_large.png<br />
<br />
File:Blood_small.png|'''Blood'''|link=Media:Blood_large.png<br />
<br />
File:Camping_S.png|'''Camping'''|link=Media:Camping_L.png<br />
<br />
File:Candy.png|'''Candy'''|link=Media:Candy_large.png<br />
<br />
File:Cars_small.png|'''Cars'''|link=Media:Cars_large.jpg<br />
<br />
File:Chateau_small.png|'''Chateau'''|link=Media:Chateau_large.jpg<br />
<br />
File:Chocolate_S.png|'''Chocolate'''|link=Media:Chocolate_1080L.png<br />
<br />
File:Cosmic_S2.png|'''Cosmic'''|link=Media:Cosmic_1080L.png<br />
<br />
File:Diablo_small.png|'''Diablo'''|link=Media:Diablo_large.png<br />
<br />
File:Dino.png|'''Dinos'''|link=Media:Dinos_large.png<br />
<br />
File:DIY.png|'''DIY'''|link=Media:DIY_large.png<br />
<br />
File:Domestic.png|'''Domestic'''|link=Media:Domestic_large.png<br />
<br />
File:Egypt_small.png|'''Egypt'''|link=Media:Egypt_large.png<br />
<br />
File:Electronics.png|'''Electronics'''|link=Media:Electronics_large.png<br />
<br />
File:Fimbulwinter_small.png|'''Fimbulwinter'''|link=Media:Fimbulwinter_large.png<br />
<br />
File:FruitBastilles_small.png|'''Fruit Bastilles'''|link=Media:FruitBastilles_large.jpg<br />
<br />
File:Ganja_S.png|'''Ganja'''|link=Media:1080Ganja.png<br />
<br />
File:Halloween_Small.png|'''Halloween'''|link=Media:Halloween_Large1080.png<br />
<br />
File:IslandAntics_small.png|'''Island Antics'''|link=Media:IslandAntics_large.jpg<br />
<br />
File:Lowpoly.png|'''Lowpoly'''|link=Media:Lowpoly_large.png<br />
<br />
File:MissileBase_small.png|'''Missile Base'''|link=Media:MissileBase_large.jpg<br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''|link=Media:Mulheresbarbadas_large.png<br />
<br />
File:Oddity_Cavernia_small.png|'''Oddity Cavernia'''|link=Media:Oddity_Cavernia_large.png<br />
<br />
File:Oddity_Earth_small.png|'''Oddity Earth'''|link=Media:Oddity_Earth_large.png<br />
<br />
File:Oddity_Frostal_small.png|'''Oddity Frostal'''|link=Media:Oddity_Frostal_large.png<br />
<br />
File:Oddity_Kaputzol_small.png|'''Oddity Kaputzol'''|link=Media:Oddity_Kaputzol_large.png<br />
<br />
File:Oddity_Mechanopolis_small.png|'''Oddity Mechanopolis'''|link=Media:Oddity_Mechanopolis_large.png<br />
<br />
File:Oddity_Tenticlia_small.png|'''Oddity Tenticilia'''|link=Media:Oddity_Tenticlia_large.png<br />
<br />
File:Origami.png|'''Origami'''|link=Media:Origami_large.png<br />
<br />
File:Picture_City_small.png|'''Picture City'''|link=Media:Picture_City_large.png<br />
<br />
File:Prehistoria_small.png|'''Prehistoria'''|link=Media:Prehistoria_large.png<br />
<br />
File:Reloaded_Arabian_small.png|'''Reloaded Arabian'''|link=Media:Reloaded_Arabian_large.png<br />
<br />
File:Reloaded_Arctic_small.png|'''Reloaded Arctic'''|link=Media:Reloaded_Arctic_large.png<br />
<br />
File:Reloaded_Hawaii_small.png|'''Reloaded Hawaii'''|link=Media:Reloaded_Hawaii_large.png<br />
<br />
File:Reloaded_Jurassic_small.png|'''Reloaded Jurassic'''|link=Media:Reloaded_Jurassic_large.png<br />
<br />
File:Reloaded_Space_small.png|'''Reloaded Space'''|link=Media:Reloaded_Space_large.png<br />
<br />
File:Reloaded_WildWest_small.png|'''Reloaded Wild West'''|link=Media:Reloaded_WildWest_large.png<br />
<br />
File:Revolution_Beach_small.png|'''Revolution Beach'''|link=Media:Revolution_Beach_large.png<br />
<br />
File:Revolution_Farm_small.png|'''Revolution Farm'''|link=Media:Revolution_Farm_large.png<br />
<br />
File:Revolution__Junkyard_small.png|'''Revolution Junkyard'''|link=Media:Revolution_Junkyard_large.png<br />
<br />
File:Revolution_Sewer_small.png|'''Revolution Sewer'''|link=Media:Revolution_Sewer_large.png<br />
<br />
File:Revolution_Spooky_small.png|'''Revolution Spooky'''|link=Media:Revolution_Spooky_large.png<br />
<br />
File:Sushi.png|'''Sushi'''|link=Media:Sushi_large.png<br />
<br />
File:Tetris.png|'''Tetris'''|link=Media:Tetris_large.png<br />
<br />
File:United_GEIGER_small.png|'''United Geiger'''|link=Media:United_GEIGER_large.png<br />
<br />
File:United_GRAVEYARD_small.png|'''United Graveyard'''|link=Media:United_GRAVEYARD_large.png<br />
<br />
File:United_HELL_small.png|'''United Hell'''|link=Media:United_HELL_large.png<br />
<br />
File:United_JUNK_small.png|'''United Junk'''|link=Media:United_JUNK_large.png<br />
<br />
File:United_MARS_small.png|'''United Mars'''|link=Media:United_MARS_large.png<br />
<br />
File:United_MONEY_small.png|'''United Money'''|link=Media:United_MONEY_large.png<br />
<br />
File:United_NAM_small.png|'''United Nam'''|link=Media:United_NAM_large.png<br />
<br />
File:United_SNOW_small.png|'''United Snow'''|link=Media:United_SNOW_large.png<br />
<br />
File:United_WARZONE_small.png|'''United Warzone'''|link=Media:United_WARZONE_large.png<br />
<br />
File:Win95.png|'''Windows 95'''|link=Media:Win95_large.png<br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=29891WkTerrainSync2021-12-04T20:29:30Z<p>Kobaryo: v. 1.2.3</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.3 (4 December 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/wormkit-modules/wkterrainsync-v-1-2-3-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/wormkit-modules/wkterrainsync-v-1-2-3-released-play-custom-missions-online-33098/?action=dlattach;attach=198231]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]. It supports online multiplayer (providing all players have the module installed) and will automatically download the custom terrain from the host if it doesn't exist locally.<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA. A full list of community-made [[WkTerrainSync#Custom_terrains|Custom Terrains]] can be found below.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
Those using the CD version of WA however, will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip wkFileOverride] to use the module.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Playing on custom terrains with those who do no have the module is possible by first converting the map to PNG. However, the debris, soil, background, custom water and other features of the terrain will be lost.<br><br />
To convert the map to PNG format:<br><br />
* Enter the detailed map settings window by right clicking the map in the lobby.<br />
* If not already in preview mode, click the preview terrain button [[Image:PreviewTerrainButton.png|inline|24px|Preview terrain button]].<br />
* Right-click the return to edit mode button [[Image:TerrainButton.png|inline|24px|Return to edit mode button]]. The map will now be a PNG map.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission /<br>Last update<br />
<br />
|-<br />
| Arachnophobia || [[People/Conejo|Conejo]], [[People/sbs|sbs]] || [https://www.tus-wa.com/files/file-2230/ TUS file] || Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027 || 2020-12-31<br />
|-<br />
| Arcade || [[People/Ducky|Ducky]] || [https://www.tus-wa.com/files/file-2252/ TUS file] || Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object || 2021-01-24<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Camping || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2258/ TUS file] || || 2021-08-17<br />
|-<br />
| Candy || unknown || [https://www.tus-wa.com/files/file-2262/ TUS file] || created using [[MapGEN]] Candy theme || 2018<br />
|-<br />
| Chocolate || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2348/ TUS file] || || 2021-11-06<br />
|-<br />
| Cosmic || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2208/ TUS file] || || 2021-11-02<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Dinos || [[Team17]] || [https://www.tus-wa.com/files/file-1276/ TUS file] || Imported from WWP || 2018<br />
|-<br />
| DIY || [[Team17]] || [https://www.tus-wa.com/files/file-2254/ TUS file] || Imported from Worms DC by [[People/Ducky|Ducky]] || 2020-09-01<br />
|-<br />
| Domestic || [[Team17]] || [https://www.tus-wa.com/files/file-1276/ TUS file] || Imported from WWP || 2018<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]], [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Electronics || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2213/ TUS file] || || 2020-12-05<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Ganja || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2162/ TUS file] || || 2021-08-17<br />
|-<br />
| Halloween || [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2415/ TUS file] || || 2021-10-23<br />
|-<br />
| Lowpoly || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2234/ TUS file] || || 2021-01-06<br />
|-<br />
| Mulheresbarbadas || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2322/ TUS file] || Art from https://mulheresbarbadas.tumblr.com/ || 2021-06-03<br />
|-<br />
| Origami || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2214/ TUS file] || || 2020-12-05<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Sushi || [[People/Conejo|Conejo]] || [https://www.tus-wa.com/files/file-2333 TUS file] || || 2021-06-07<br />
|-<br />
| Tetris || [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2261/ TUS file] || || 2016-06-28<br />
|-<br />
| Win95 || [[People/Ducky|Ducky]] || [https://www.tus-wa.com/files/file-2253/ TUS file] || || 2020-09-01<br />
|-<br />
| Worms: A Space Oddity terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2399/ TUS file] || Contains: Cavernia, Earth, Frostal, Kaputzol, Mechanopolis, Tenticilia || 2021-09-12<br />
|-<br />
| Worms: Battle Islands terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2405/ TUS file] || Contains: Area 51, Chemical, Jungle, Nuclear, Polar, Underwater || 2021-09-19<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms Revolution terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2391/ TUS file] || Contains: Beach, Farm, Junkyard, Sewer, Spooky || 2021-09-10<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
A combined pack that has everything mentioned above as of 2021-09-14 is available [https://cdn.discordapp.com/attachments/416225356706480130/887420782760841256/terrains.rar here].<br><br />
It was posted on [[People/Sensei|Sensei's]] Discord [https://discord.gg/UBRBhk6 server] in [https://discord.com/channels/416225356706480128/416225356706480130/887420783465463808 this message].<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''|link=Media:Arcade_large.png<br />
<br />
File:Blood_small.png|'''Blood'''|link=Media:Blood_large.png<br />
<br />
File:Camping_S.png|'''Camping'''|link=Media:Camping_L.png<br />
<br />
File:Candy.png|'''Candy'''|link=Media:Candy_large.png<br />
<br />
File:Chocolate_S.png|'''Chocolate'''|link=Media:Chocolate_1080L.png<br />
<br />
File:Cosmic_S2.png|'''Cosmic'''|link=Media:Cosmic_1080L.png<br />
<br />
File:Diablo_small.png|'''Diablo'''|link=Media:Diablo_large.png<br />
<br />
File:Dino.png|'''Dinos'''|link=Media:Dinos_large.png<br />
<br />
File:DIY.png|'''DIY'''|link=Media:DIY_large.png<br />
<br />
File:Domestic.png|'''Domestic'''|link=Media:Domestic_large.png<br />
<br />
File:Egypt_small.png|'''Egypt'''|link=Media:Egypt_large.png<br />
<br />
File:Electronics.png|'''Electronics'''|link=Media:Electronics_large.png<br />
<br />
File:Fimbulwinter_small.png|'''Fimbulwinter'''|link=Media:Fimbulwinter_large.png<br />
<br />
File:Ganja_S.png|'''Ganja'''|link=Media:1080Ganja.png<br />
<br />
File:Halloween_Small.png|'''Halloween'''|link=Media:Halloween_Large1080.png<br />
<br />
File:Lowpoly.png|'''Lowpoly'''|link=Media:Lowpoly_large.png<br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''|link=Media:Mulheresbarbadas_large.png<br />
<br />
File:Oddity_Cavernia_small.png|'''Oddity Cavernia'''|link=Media:Oddity_Cavernia_large.png<br />
<br />
File:Oddity_Earth_small.png|'''Oddity Earth'''|link=Media:Oddity_Earth_large.png<br />
<br />
File:Oddity_Frostal_small.png|'''Oddity Frostal'''|link=Media:Oddity_Frostal_large.png<br />
<br />
File:Oddity_Kaputzol_small.png|'''Oddity Kaputzol'''|link=Media:Oddity_Kaputzol_large.png<br />
<br />
File:Oddity_Mechanopolis_small.png|'''Oddity Mechanopolis'''|link=Media:Oddity_Mechanopolis_large.png<br />
<br />
File:Oddity_Tenticlia_small.png|'''Oddity Tenticilia'''|link=Media:Oddity_Tenticlia_large.png<br />
<br />
File:Origami.png|'''Origami'''|link=Media:Origami_large.png<br />
<br />
File:Picture_City_small.png|'''Picture City'''|link=Media:Picture_City_large.png<br />
<br />
File:Prehistoria_small.png|'''Prehistoria'''|link=Media:Prehistoria_large.png<br />
<br />
File:Reloaded_Arabian_small.png|'''Reloaded Arabian'''|link=Media:Reloaded_Arabian_large.png<br />
<br />
File:Reloaded_Arctic_small.png|'''Reloaded Arctic'''|link=Media:Reloaded_Arctic_large.png<br />
<br />
File:Reloaded_Hawaii_small.png|'''Reloaded Hawaii'''|link=Media:Reloaded_Hawaii_large.png<br />
<br />
File:Reloaded_Jurassic_small.png|'''Reloaded Jurassic'''|link=Media:Reloaded_Jurassic_large.png<br />
<br />
File:Reloaded_Space_small.png|'''Reloaded Space'''|link=Media:Reloaded_Space_large.png<br />
<br />
File:Reloaded_WildWest_small.png|'''Reloaded Wild West'''|link=Media:Reloaded_WildWest_large.png<br />
<br />
File:Revolution_Beach_small.png|'''Revolution Beach'''|link=Media:Revolution_Beach_large.png<br />
<br />
File:Revolution_Farm_small.png|'''Revolution Farm'''|link=Media:Revolution_Farm_large.png<br />
<br />
File:Revolution__Junkyard_small.png|'''Revolution Junkyard'''|link=Media:Revolution_Junkyard_large.png<br />
<br />
File:Revolution_Sewer_small.png|'''Revolution Sewer'''|link=Media:Revolution_Sewer_large.png<br />
<br />
File:Revolution_Spooky_small.png|'''Revolution Spooky'''|link=Media:Revolution_Spooky_large.png<br />
<br />
File:Sushi.png|'''Sushi'''|link=Media:Sushi_large.png<br />
<br />
File:Tetris.png|'''Tetris'''|link=Media:Tetris_large.png<br />
<br />
File:United_GEIGER_small.png|'''United Geiger'''|link=Media:United_GEIGER_large.png<br />
<br />
File:United_GRAVEYARD_small.png|'''United Graveyard'''|link=Media:United_GRAVEYARD_large.png<br />
<br />
File:United_HELL_small.png|'''United Hell'''|link=Media:United_HELL_large.png<br />
<br />
File:United_JUNK_small.png|'''United Junk'''|link=Media:United_JUNK_large.png<br />
<br />
File:United_MARS_small.png|'''United Mars'''|link=Media:United_MARS_large.png<br />
<br />
File:United_MONEY_small.png|'''United Money'''|link=Media:United_MONEY_large.png<br />
<br />
File:United_NAM_small.png|'''United Nam'''|link=Media:United_NAM_large.png<br />
<br />
File:United_SNOW_small.png|'''United Snow'''|link=Media:United_SNOW_large.png<br />
<br />
File:United_WARZONE_small.png|'''United Warzone'''|link=Media:United_WARZONE_large.png<br />
<br />
File:Win95.png|'''Windows 95'''|link=Media:Win95_large.png<br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29173WkWormOrder2021-10-02T19:52:07Z<p>Kobaryo: 1.2.0</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.2.0 / 2 Oct 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/wormkit-modules/wkwormorder-v-1-2-0-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/wormkit-modules/wkwormorder-v-1-2-0-released-33536/?action=dlattach;attach=196954 wkWormOrder 1.2.0 (474 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* To enable displaying order of your worms, use '''/order my''' command in game chat.<br />
* To enable displaying order of all worms, use '''/order all''' command in game chat.<br />
* During replay playback all worms have their numbers displayed. <br />
* The displayed worm name format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with '''{name}''' (team name), '''{owner}''' (owner nickname), '''{hp}''' (sum of HP of all worms within the team) and '''{wins}''' (number of team wins in match) tags. To enable this feature set: '''TeamNameShowOwner = 1''' or use '''/owner''' command in game chat.</div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=29064WkTerrainSync2021-09-13T10:41:11Z<p>Kobaryo: Space Oddity terrains</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.2 (22 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/?action=dlattach;attach=196130]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms Revolution terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2391/ TUS file] || Contains: Beach, Farm, Junkyard, Sewer, Spooky<br />
|| 2021-09-10<br />
|-<br />
| Worms Space Oddity terrain pack || [[Team17]], [[User:Carmine|Carmine]] || [https://www.tus-wa.com/files/file-2399/ TUS file] || Contains: Cavernia, Earth, Frostal, Kaputzol, Mechanopolis, Tenticilia<br />
|| 2021-09-12<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29060WkWormOrder2021-09-11T18:31:50Z<p>Kobaryo: </p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.1.0 / 11 Sep 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-1-0-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-1-0-released-33536/?action=dlattach;attach=196474 wkWormOrder 1.1.0 (444 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* Worms belonging to you have their numbers displayed. During replay playback all worms have their numbers displayed. The displayed format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* To enable displaying order of all worms, use '''/order''' command in game chat. Usage of this feature should be discussed with other players beforehand.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with '''{name}''', '''{owner}''' and '''{hp}''' (sum of HP of all worms within the team) tags. To enable this feature set: '''TeamNameShowOwner = 1''' or use '''/owner''' command in game chat.</div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29059WkWormOrder2021-09-11T18:31:29Z<p>Kobaryo: Version 1.1.0</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.1.0 / 11 Sep 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-1-0-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-1-0-released-33536/?action=dlattach;attach=196474 wkWormOrder 1.0.1 (444 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* Worms belonging to you have their numbers displayed. During replay playback all worms have their numbers displayed. The displayed format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* To enable displaying order of all worms, use '''/order''' command in game chat. Usage of this feature should be discussed with other players beforehand.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with '''{name}''', '''{owner}''' and '''{hp}''' (sum of HP of all worms within the team) tags. To enable this feature set: '''TeamNameShowOwner = 1''' or use '''/owner''' command in game chat.</div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=29058WkTerrainSync2021-09-11T13:21:10Z<p>Kobaryo: Added Worms Revolution terrain pack</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.2 (22 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/?action=dlattach;attach=196130]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms Revolution terrain pack || [[Team17]], [[User:Cammy|Cammy]] || [https://www.tus-wa.com/files/file-2391/ TUS file] || Contains: Beach, Farm, Junkyard, Sewer, Spooky<br />
|| 2021-09-10<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29018WkWormOrder2021-09-04T21:39:23Z<p>Kobaryo: Version 1.0.1</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.0.1 / 4 Sep 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-1-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-1-released-33536/?action=dlattach;attach=196360 wkWormOrder 1.0.1 (441 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* Worms belonging to you have their numbers displayed. During replay playback all worms have their numbers displayed. The displayed format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with **{name}** and **{owner}** tags. To enable this feature set: '''TeamNameShowOwner = 1'''</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=29014WormKit2021-09-03T10:20:45Z<p>Kobaryo: /* Current modules by community */</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTextMacros]]'''<br />
| Implements automatic text macros in both lobby and in-game chat.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[[wkToolAssist]]'''<br />
| Adds Tool Assisted features - playing the game in super slow motion or frame by frame, saving and restoring game state, showing roping trajectory<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkWormOrder]]'''<br />
| Appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29013WkWormOrder2021-09-03T10:20:17Z<p>Kobaryo: </p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.0.0 / 3 Sep 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-0-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-0-released-33536/?action=dlattach;attach=196339 wkWormOrder 1.0.0 (441 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* Worms belonging to you have their numbers displayed. During replay playback all worms have their numbers displayed. The displayed format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with **{name}** and **{owner}** tags. To enable this feature set: '''TeamNameShowOwner = 1'''</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=29012WormKit2021-09-03T10:15:07Z<p>Kobaryo: /* Current modules by community */</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTextMacros]]'''<br />
| Implements automatic text macros in both lobby and in-game chat.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[[wkToolAssist]]'''<br />
| Adds Tool Assisted features - playing the game in super slow motion or frame by frame, saving and restoring game state, showing roping trajectory<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkWormOrder]]'''<br />
| Appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkWormOrder&diff=29011WkWormOrder2021-09-03T10:14:12Z<p>Kobaryo: Created page with "{{lowercase title}} {{ParentArticle|WormKit}} {{Software_infobox | name = wkWormOrder | developer = nizikawa | version = 1.0.0 / 3 Sep 2021 | games = Worms Armageddo..."</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkWormOrder<br />
| developer = [[nizikawa]]<br />
| version = 1.0.0 / 3 Sep 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = any<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkWormOrder Github Page] [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-0-released-33536/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkwormorder-v-1-0-0-released-33536/?action=dlattach;attach=196339 wkWormOrder 1.0.0 (441 KB)]<br />
}}<br />
<br />
[[WormKit]] module that appends worm order numbers to their names and allows randomizing the worm order within the team in multiplayer games.<br />
<br />
== Features ==<br />
* Worms belonging to you have their numbers displayed. During replay playback all worms have their numbers displayed. The displayed format is customizable in .ini with '''{name}''' and '''{number}''' tags.<br />
* In multiplayer games the worm order within your team can be scrambled. The order is scrambled every time you add the team to the round roster. To enable this feature set: '''ScrambleWormOrder = 1'''<br />
* Team name bars can have their owner name displayed. The displayed format is customizable with **{name}** and **{owner}** tags. To enable this feature set: '''TeamNameShowOwner = 1'''</div>Kobaryohttps://worms2d.info/?title=WormNAT2&diff=28980WormNAT22021-09-02T08:43:48Z<p>Kobaryo: Added note about Sandboxie</p>
<hr />
<div>{{ParentArticle|[[WormKit]]}}<br />
{{Languages|en|WormNAT2|ru|WormNAT2/ru}}<br />
{{Software_infobox<br />
| icon = WormNAT.gif<br />
| name = WormNAT 2<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| version = 2.3 / August 22, 2015<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.6.28.0+<br />
| language = Delphi<br />
| license = [https://github.com/CyberShadow/WormKit Open-source]<br />
| download = [https://worms.thecybershadow.net/wormkit/wkWormNAT2.zip wkWormNAT2.zip (92 KB)]<br />
}}<br />
[[WormNAT2]] is a [[WormKit]] module which enables players behind NAT or firewalls to host games which are joinable by everyone. It is a rewrite of the first WormNAT module, which required extensive configuration and that all players have the module installed.<br />
<br />
The advantages of WormNAT2 over WormNAT / [[HostingBuddy]] / Hamachi:<br />
* very easy to set up (extract WormNAT2 DLLs to W:A folder, enable "Load WormKit modules" in Advanced Settings)<br />
* no configuration is necessary<br />
* anyone can join games hosted with WormNAT2<br />
* games are hosted as usual, there is no need to configure the game settings with tedious text commands<br />
<br />
== Usage ==<br />
<br />
If other players time out when trying to join your hosted games, and nobody joins, you can follow these steps.<br />
<br />
# In WA -> options (bottom-right) -> "Advanced", enable "Load WormKit modules".<br />
# Ensure no unexpected "wk*.dll" files are in your WA installation folder, where WA.exe is located. The option in step 1 causes WA to load these, so any that you don't know about could cause unexpected behavior that may be disruptive or even dangerous.<br />
# Download wkWormNAT2.zip.<br />
# Extract the contents of wkWormNAT2.zip to your WA installation folder, where WA.exe is located.<br />
<br />
After these steps, installation is done. You can now run the game and host as normal using the "Host" button in WormNET and other players should no longer time out when trying to join your games.<br />
<br />
If you don't want to connect to other players through a proxy server and still want to be able to host without issues, you can configure hosting manually with the information in the [[Hosting guide|hosting guide]].<br />
<br />
== Known issues ==<br />
<br />
* '''BitDefender''' and [https://www.sandboxie.com/ Sandboxie] are known to prevent wkWormNAT2 from working, and cause the "''Ack, wkWormNAT2 initialization error''" message.<br />
** This happens even if the antivirus is turned off and the game directory added to exclusions; the antivirus must be completely uninstalled to prevent this problem.<br />
** A workaround is to copy [https://dump.cy.md/aa30ff1ea3e325dbd51f40eb7c6a475e/wsock32.dll this file] to the installation directory of the game to trick BitDefender into not blocking it.<br />
<br />
[[Image:WormNAT2.svg|thumb|A crude drawing of how WormNAT2 works]]<br />
<br />
== How it works ==<br />
WormNAT2 works by asking a ''reverse proxy'' (which is running the HostingProxy software) to host the game for the player. A control connection is opened to the proxy server, '''proxy.wormnet.net''' on port 9301. As soon as the connection is established, the proxy assigns a port for the game and sends back the port number through the control connection. WormNAT2 creates the game at the address '''proxy.wormnet.net:''port'''''. <br />
<br />
Once the game is created, every time a new player connects to the proxy, the proxy creates a new listening port for WormNAT2 and sends the port number through the control connection. WormNAT2 then connects to the specified port; the proxy then proceeds to route data between the two connections.<br />
<br />
Internally, WormNAT2 operates by monitoring [[WormNET]] game creation and closing. Incoming connections are simulated by creating actual connections from within the same process, and routing the data between those connections and connections to the proxy server.<br />
<br />
== See also ==<br />
* [[Hosting Guide]]<br />
* [[HostingBuddy]]</div>Kobaryohttps://worms2d.info/?title=WkToolAssist&diff=28950WkToolAssist2021-08-29T11:34:55Z<p>Kobaryo: updated download link</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkToolAssist<br />
| developer = [[nizikawa]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.1<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| license = Closed-source<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wktoolassist-v-0-1-0-released-33517/ TUS Page]<br />
| download = [https://files.catbox.moe/cikkza.zip wkToolAssist v. 0.1.0 (13.2 MB)]<br />
}}<br />
<br />
This [[WormKit]] that implements some features present in Tool Assisted WA Builds by Deadcode.<br />
<br />
== Features ==<br />
* Adjust game speed at any time<br />
* Set checkpoints to rollback game state<br />
* Step frame forward/backward<br />
* Show trajectories of moving worms, projectiles and mines<br />
* Record .wagame replays in a format compatible with stock WA<br />
<br />
== Limitations ==<br />
* To prevent abuse, the module comes bundled with a special version of WA.exe with disabled network functionality. The module is closed source.<br />
* Version 0.1.0 lacks the ability to edit existing replays. This feature is planned for version 0.2.0<br />
* Recorded replays contain chat message about wkToolAssist being used<br />
* Team flags are replaced with "TA" flag<br />
<br />
== Installation ==<br />
# Extract ToolAssist.dll and TA_*.exe matching your WA version to your Worms Armageddon installation directory<br />
# Launch TA_*.exe<br />
<br />
== Controls ==<br />
* Keys 0-9 - set game speed to predefined values:<br />
1: 1.0x,<br />
2: 0.5x,<br />
3: 0.25x<br />
4: 0.15x<br />
5: 0.1x<br />
6: 0.05x<br />
7: 0.025x<br />
8: 0.0125x<br />
9: 0.005x<br />
0: stop time<br />
* Keys + - increase/decrease game speed by 0.01x<br />
* Keys [ ] step a single frame backward/forward<br />
* Key S - save current frame as checkpoint<br />
* Key R - restore game state to the last checkpoint<br />
* Key Z - remove last checkpoint and restore state to the previous one<br />
* Key ~ - revert game to frame 0 and start playing until the last checkpoint<br />
<br />
== Notes on keyboard inputs ==<br />
* Game controls in stock WA are buggy at game speeds 0.25x and below. To fix this problem the module implements it's own keyboard handling logic and uses it at speeds <= 0.25x<br />
* The custom key logic does not respect custom mappings used in wkRemapKeys<br />
* Some keys such as space or enter are set as sticky - pressing them once remembers the state until the next time the key state is read by the game, usually on the next logic frame.<br />
* To "unpress" sticky key, hold shift and press the keyboard key you want to unpress.<br />
* The list of active keys is displayed in the screen corner</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=28949WormKit2021-08-28T16:28:26Z<p>Kobaryo: added wkToolAssist</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTextMacros]]'''<br />
| Implements automatic text macros in both lobby and in-game chat.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[[wkToolAssist]]'''<br />
| Adds Tool Assisted features - playing the game in super slow motion or frame by frame, saving and restoring game state, showing roping trajectory<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkToolAssist&diff=28948WkToolAssist2021-08-28T16:25:26Z<p>Kobaryo: Created page with "{{lowercase title}} {{ParentArticle|WormKit}} {{Software_infobox | name = wkToolAssist | developer = nizikawa | games = W:A | waver = 3.8.1 | waed..."</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkToolAssist<br />
| developer = [[nizikawa]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.1<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| license = Closed-source<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wktoolassist-v-0-1-0-released-33517/ TUS Page]<br />
| download = [https://files.catbox.moe/8wipce.zip wkToolAssist v. 0.1.0 (18.5 MB)]<br />
}}<br />
<br />
This [[WormKit]] that implements some features present in Tool Assisted WA Builds by Deadcode.<br />
<br />
== Features ==<br />
* Adjust game speed at any time<br />
* Set checkpoints to rollback game state<br />
* Step frame forward/backward<br />
* Show trajectories of moving worms, projectiles and mines<br />
* Record .wagame replays in a format compatible with stock WA<br />
<br />
== Limitations ==<br />
* To prevent abuse, the module comes bundled with a special version of WA.exe with disabled network functionality. The module is closed source.<br />
* Version 0.1.0 lacks the ability to edit existing replays. This feature is planned for version 0.2.0<br />
* Recorded replays contain chat message about wkToolAssist being used<br />
* Team flags are replaced with "TA" flag<br />
<br />
== Installation ==<br />
# Extract ToolAssist.dll and TA_*.exe matching your WA version to your Worms Armageddon installation directory<br />
# Launch TA_*.exe<br />
<br />
== Controls ==<br />
* Keys 0-9 - set game speed to predefined values:<br />
1: 1.0x,<br />
2: 0.5x,<br />
3: 0.25x<br />
4: 0.15x<br />
5: 0.1x<br />
6: 0.05x<br />
7: 0.025x<br />
8: 0.0125x<br />
9: 0.005x<br />
0: stop time<br />
* Keys + - increase/decrease game speed by 0.01x<br />
* Keys [ ] step a single frame backward/forward<br />
* Key S - save current frame as checkpoint<br />
* Key R - restore game state to the last checkpoint<br />
* Key Z - remove last checkpoint and restore state to the previous one<br />
* Key ~ - revert game to frame 0 and start playing until the last checkpoint<br />
<br />
== Notes on keyboard inputs ==<br />
* Game controls in stock WA are buggy at game speeds 0.25x and below. To fix this problem the module implements it's own keyboard handling logic and uses it at speeds <= 0.25x<br />
* The custom key logic does not respect custom mappings used in wkRemapKeys<br />
* Some keys such as space or enter are set as sticky - pressing them once remembers the state until the next time the key state is read by the game, usually on the next logic frame.<br />
* To "unpress" sticky key, hold shift and press the keyboard key you want to unpress.<br />
* The list of active keys is displayed in the screen corner</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=28944WormKit2021-08-25T20:11:03Z<p>Kobaryo: added wkTextMacros</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTextMacros]]'''<br />
| Implements automatic text macros in both lobby and in-game chat.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkTextMacros&diff=28943WkTextMacros2021-08-25T20:09:36Z<p>Kobaryo: Created page with "{{lowercase title}} {{ParentArticle|WormKit}} {{Software_infobox | name = wkTextMacros | developer = terion | games = W:A | waver = 3.8.x | waedit..."</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTextMacros<br />
| developer = [[terion]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| license = [https://www.tus-wa.com/forums/worms-armageddon/wkmacros-32901/?action=dlattach;attach=192642 Open-source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkmacros-32901/msg276814/#msg276814 TUS Page]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkmacros-32901/?action=dlattach;attach=192641 wkTextMacros (224 kB)]<br />
}}<br />
<br />
<br />
This [[WormKit]] module implements automatic text macros in both lobby and in-game chat.<br />
<br />
== How to use it ==<br />
# Upon first launch, the module will create a macros/ directory inside your WA installation dir.<br />
# Inside macros/ directory create a .txt file with the name of your desired command (for example, macros/rules.txt will be available as /rules command)<br />
# Edit this file with notepad and fill it with your desired text macro (save it as plaintext, ascii file)<br />
# When in lobby or in-game, type /macros to see a list of all available commands<br />
# Type the name of your command to send the text to all players<br />
<br />
== Notes ==<br />
* The text files are scanned and read on game launch and whenever you use /macros command. Thus macro file creation/modification/deletion will be reflected only when you type /macros command or restart the game.<br />
* Text macros in lobby are sent as a single message and are limited to 1024 characters<br />
* Text macros in-game are split by newline character into separate messages and are limited to 256 characters per line. Up to 3 text lines can be used in a single macro.<br />
* Spamming text macros will trigger automatic /ignore by all players, so keep your macros short and use this module with moderation.<br />
* Do not use space or other special characters in command names<br />
* Do not use command names that overlap with bult-in game commands (/test, /version, etc)<br />
* This module has been tested with WA version 3.8.0. It will not work with WA 3.7.2.2 and earlier versions. It might work with newer WA releases if no significant changes are made to lobby or game chat functions.</div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=28941WkTerrainSync2021-08-22T14:10:22Z<p>Kobaryo: Version 1.2.2</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.2 (22 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-2-released-play-custom-missions-online-33098/?action=dlattach;attach=196130]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=28938WkTerrainSync2021-08-18T09:31:39Z<p>Kobaryo: Version 1.2.1a</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.1a (18 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1a-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1a-released-play-custom-missions-online-33098/?action=dlattach;attach=196025]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=28937WkTerrainSync2021-08-18T07:58:26Z<p>Kobaryo: </p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.1 (18 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1-released-play-custom-missions-online-33098/?action=dlattach;attach=196023]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=WkTerrainSync&diff=28936WkTerrainSync2021-08-18T07:37:49Z<p>Kobaryo: version 1.2.1</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTerrainSync<br />
| developer = nizikawa<br />
| version = v1.2.1 (18 August 2021)<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| language = C++<br />
| license = [https://github.com/nizikawa-worms/wkTerrainSync Open Source]<br />
| website = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1-released-play-custom-missions-online-33098/ TUS thread]<br />
| download = [https://www.tus-wa.com/forums/worms-armageddon/wkterrainsync-v-1-2-1-released-play-custom-missions-online-33098/?action=dlattach;attach=196020]<br />
}}<br />
<br />
[[Image:DomesticTerrain.png|thumb|230px|Domestic Terrain]]<br />
<br />
'''wkTerrainSync''' is a module for [[WormKit]] that allows additional W:A terrains to be installed and selected in the [[Map_Editor_Guide|Map editor]]<br />
<br />
It makes it easy for terrains such as Dinos and Domestic (which are present on the [[WWP]] CD) to be installed and played with WA.<br />
<br />
It superseded [[WkTerrain]] adding new features such as data synchronization for network games and sprite addition/replacement.<br />
<br />
In addition to custom terrain functionality, later updates added support for generating custom-sized maps in buit-in map generator and support for playing custom missions in both offline and online multiplayer.<br />
<br />
For information on how to put together your own custom terrain, see the [[Terrain Creation Guide]].<br />
<br />
== Usage ==<br />
wkTerrainSync does not require any special configuration or user interaction.<br />
<br />
If you are joining an online game that uses a new terrain file that you currently don't have installed, you will see an "Invalid map file" in map thumbnail and multiple messages about terrain data download will appear in lobby chat. This means the terrain file is being downloaded from the host and a proper map thumbnail will appear once the terrain is downloaded. This should take few seconds depending on network speed.<br />
<br />
Those using the CD version of WA will require [http://worms.thecybershadow.net/wormkit/wkFileOverride.zip FileOverride] to use this module.<br />
<br />
To troubleshoot the module, enable dev console in .ini file and examine the logged messages<br />
<br />
'''Terrains:'''<br />
*A valid terrain directory contains two files:<br />
**Level.dir, the main [[Graphics_directory|graphics directory]] which contains all the texture assets. This file can be read and edited using the [[WA_directory_editor|WA Directory Editor]].<br />
**TEXT.IMG, this represents the texture thumbnail as shown in the map editor.<br />
*When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.<br />
**To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.<br />
**To limit this selection to only default terrains, hold ALT key and click on the thumbnail.<br />
'''Missions:'''<br />
An additional feature separate from custom terrains is the ability to use the single player mission functionality in online and offline multiplayer.<br />
*A [[Worms_Armageddon_mission_file|mission file]] can be placed in the Saved Levels directory with the same name as the map (PNG, IMG and BIT are supported) and it will be loaded by the module when the map is selected.<br />
<br />
<br />
== Features ==<br />
'''Data synchronization features:'''<br />
*Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting<br />
*Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names<br />
*File transfers - missing terrain files are automatically downloaded from the host player<br />
*Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed<br />
*Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts<br />
*Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list<br />
<br />
'''Terrain customization features:'''<br />
*Terrain files can include additional parallax sprites - back2.spr displayed in far distance behind regular back.spr ; front.spr displayed in front of the map<br />
*Removed sprite loader limitations when handling back.spr, back2.spr and front.spr - sprites are no longer limited to 640x160px size and can be animated like regular sprites<br />
*Terrains can override any sprite in the game, including worm animations, weapon projectiles and clouds - place gfx0/spritename.spr (normal palette) and gfx1/spritename.spr (colorblind palette) within terrain.dir to override any sprite<br />
*Terrains can override water.dir for custom water color and animations - place water.dir next to level.dir in terrain directory. Use https://worms2d.info/Water_color_editor to generate custom water.dir<br />
*Support for custom-sized random maps generated with built-in map generator. The maps can be scaled with 0.1x scale increments in both width and height dimensions up to 5.0x scale max.<br />
<br />
'''Mission features:'''<br />
*For your convenience the module will automatically copy default WA mission files to User/SavedLevels/Mission/WA/ folder (and slightly fix them).<br />
*Custom mission replay files are fully supported by wkTerrainSync.<br />
*By default, the mission files use an empty .WSC scheme file that is later populated by .WAM script when the mission begins - it will be labeled as [ Default mission scheme ]. This scheme can be edited by changing basic parameters such as turn time, round time, etc. It is also possible to enable 3.8 scheme extended options.<br />
*Mission files can also provide own .WSC scheme, it will be labeled as [ Mission-provided scheme ].<br />
*The module adds some custom fields to WAM file format:<br />
<pre>[HumanTeam] or [CPUTeamX]<br />
Ammo_SkipGo=1<br />
Delay_SkipGo=2<br />
Ammo_Surrender=3<br />
Delay_Surrender=4<br />
<br />
[CPUTeamX]<br />
Optional = 1 ; a CPU team will not be spawned if no player team is added to cover this team<br />
TeamNameValue=Team Name Text ; sets custom team name instead of one specified by TeamNameNumber<br />
WormX_NameValue=Worm Name Text ; sets custom worm name instead of one specified by WormX_NameNumber<br />
<br />
[EventXXXX]<br />
TypeOfEvent=10 ; show text event<br />
Text_String_Value=Custom text message to be displayed ; sets custom text message instead of one specified by Text_String_Index</pre><br />
<br />
<br />
== Custom terrains ==<br />
Here are some terrains available to use.<br />
Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.<br />
<br />
{| class="wikitable sortable" width="75%" border="1" cellpadding="2" cellspacing="0" style="margin-top: 0.5em;" summary="Custom terrains"<br />
|-<br />
! Name<br />
! Author<br />
! Download<br />
! Notes<br />
! Submission / Last update<br />
<br />
|-<br />
| Blood || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2233/ TUS file] || || 2021-01-04<br />
|-<br />
| Diablo || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2235/ TUS file] || || 2021-01-06<br />
|-<br />
| Egypt || [[User:ARTemych|ARTemych]] and [[People/SiD|SiD]] || [https://www.tus-wa.com/files/file-2180/ TUS file] || Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 || 2020-10-22<br />
|-<br />
| Fimbulwinter || [[1gor Melitonov]] || [https://www.tus-wa.com/files/file-2242/ TUS file] || || 2021-01-10<br />
|-<br />
| Picture City || [[User:Gray|gray]] || [https://www.tus-wa.com/files/file-2272 TUS file] || from Rayman 1. Includes a custom water file. || 2021-03-24<br />
|-<br />
| Prehistoria || [[People/Korydex|Korydex]] || [https://www.tus-wa.com/files/file-2231/ TUS file] || Lost Vikings || 2021-01-02<br />
|-<br />
| Worms Reloaded terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]], [[User:King-Gizzard|King-Gizzard]] || [https://www.tus-wa.com/files/file-2341/ TUS file] || Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West || 2021-07-01<br />
|-<br />
| Worms United terrain pack || [[Team17]], [[User:Nizikawa|nizikawa]] || [https://www.tus-wa.com/files/file-2274/ TUS file] || Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone || 2021-04-03<br />
|-<br />
|}<br />
<br />
==Gallery==<br />
<br />
<!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --><br />
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --><br />
<!-- Format your entry as follows: --><br />
<!-- File:Preview_image.png|'''Title'''<br>by [[People/Author|Author]] <br>[https://downloadurl/ Download]<br><small>date<br>notes</small>|link=Media:Full_image.jpg --><br />
<br />
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.<br />
<br />
<gallery mode="nolines" widths="250px" heights="250px"><br />
<br />
File:Arachnophobia.png|'''Arachnophobia'''<br>by [[People/sbs|sbs]] and [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2230/ TUS file]<br><small>2020-12-31<br>Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027</small>|link=Media:Arachnophobia_full.jpg<br />
<br />
File:Arcade.png|'''Arcade'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2252/ TUS file]<br><small>2021-01-24<br>Participation of [[User:OScarDiAnno|oScarDiAnno]] who made the "worm plush grabbed by a claw" object</small><br />
<br />
File:Camping_Small.png|'''Camping'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2258/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Camping.png<br />
<br />
File:Candy.png|'''Candy'''<br>by unknown<br>[https://www.tus-wa.com/files/file-2262/ TUS file]<br><small>2018<br>created using [[MapGEN]] Candy theme</small><br />
<br />
File:Chocolate_Small.png|'''Chocolate'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2348/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Chocolate.png<br />
<br />
File:Cosmic_Small.png|'''Cosmic'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2208/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Cosmic.png<br />
<br />
File:Dino.png|'''Dinos'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Domestic.png|'''Domestic'''<br>by Team17<br>[https://www.tus-wa.com/files/file-1276/ TUS file]<br><small>2018<br>Imported from WWP</small><br />
<br />
File:Ganja_Small.png|'''Ganja'''<br>by King-Gizzard<br>[https://www.tus-wa.com/files/file-2162/ TUS file]<br><small>2021-08-17</small>|link=Media:1080Ganja.png<br />
<br />
File:Tetris.png|'''Tetris'''<br>by [[People/SiD|SiD]]<br>[https://www.tus-wa.com/files/file-2261/ TUS file]<br><small>2016-06-28</small><br />
<br />
File:Win95.png|'''Windows 95'''<br>by [[People/Ducky|Ducky]]<br>[https://www.tus-wa.com/files/file-2253/ TUS file]<br><small>2020-09-01</small><br />
<br />
File:DIY.png|'''DIY'''<br>by Team17<br>[https://www.tus-wa.com/files/file-2254/ TUS file]<br><small>2020-09-01<br>Imported from Worms DC by [[People/Ducky|Ducky]]</small><br />
<br />
File:Electronics.png|'''Electronics'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2213/ TUS file]<br><small>2020-12-05</small><br />
<br />
File:Lowpoly.png|'''Lowpoly'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2234/ TUS file]<br><small>2021-01-06</small><br />
<br />
File:Mulheresbarbadas.png|'''Mulheresbarbadas'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2322/ TUS file]<br><small>2021-06-03<br>Art from https://mulheresbarbadas.tumblr.com/</small><br />
<br />
File:Sushi.png|'''Sushi'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2333 TUS file]<br><small>2021-06-07</small><br />
<br />
File:Origami.png|'''Origami'''<br>by [[People/Conejo|Conejo]]<br>[https://www.tus-wa.com/files/file-2214/ TUS file]<br><small>2020-12-05</small><br />
</gallery></div>Kobaryohttps://worms2d.info/?title=Template:Game_navbox/Software&diff=28931Template:Game navbox/Software2021-08-17T10:24:40Z<p>Kobaryo: Added link to WormKit page</p>
<hr />
<div>{{ParentArticle|[[Template:Game navbox]]}}__NOEDITSECTION__<br />
<onlyinclude>{| border="0"<br />
|-<br />
| [[File:Software_Generic3.png|64px|link=Software|Software]]<br />
| <span style="font-size: 132%;">'''[[Software]]'''</span><br />
* [[Software#WormNET snoopers|Snoopers]]<br />
* [[Software#Team editors|Team editors]]<br />
* [[Software#Scheme/option editors|Scheme editors]]<br />
* [[WormKit|WormKit modules]]<br />
|}</onlyinclude><br />
----<br />
Image used in the template: [[:Image:Software_Generic3.png]]</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=28928WormKit2021-08-17T10:05:53Z<p>Kobaryo: Added wkMultiInstance</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkMultiInstance]]'''<br />
| Allows launching multiple WA instances without file conflicts.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkMultiInstance&diff=28925WkMultiInstance2021-08-17T10:04:37Z<p>Kobaryo: Created page with "{{lowercase title}} {{ParentArticle|WormKit}} {{Software_infobox | name = wkMultiInstance | developer = nizikawa | version = 1.1.0 / 23 Jul 2021 | games = Worms Arma..."</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkMultiInstance<br />
| developer = [[nizikawa]]<br />
| version = 1.1.0 / 23 Jul 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = any<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/nizikawa-worms/wkMultiInstance Github Page]<br />
| download = [https://github.com/nizikawa-worms/wkMultiInstance/releases/download/1.1.0/wkMultiInstance.zip wkMultiInstance 1.1.0 (177 KB)]<br />
}}<br />
<br />
[[WormKit]] module that allows launching multiple WA instances without file conflicts.<br />
<br />
Temporary level files are moved from WA's installation directory to %TEMP%.</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=28924WormKit2021-08-17T09:47:02Z<p>Kobaryo: added wkTTS</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkTTS]]'''<br />
| Reads chat messages with text-to-speech.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/greisane|greisane]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkTTS&diff=28923WkTTS2021-08-17T09:45:25Z<p>Kobaryo: Created page with "{{lowercase title}} {{ParentArticle|WormKit}} {{Software_infobox | name = wkTTS | developer = greisane | version = 1.1.0 / 14 Aug 2021 | games = Worms Armageddon|W:A..."</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
{{Software_infobox<br />
| name = wkTTS<br />
| developer = [[greisane]]<br />
| version = 1.1.0 / 14 Aug 2021<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.8.x<br />
| waeditions = {{WA editions|cd|steam|gog}}<br />
| language = C++<br />
| website = [https://github.com/greisane/wkTTS Github Page]<br />
| download = [https://github.com/greisane/wkTTS/releases/download/v1.1.0/wkTTS-1.1.0.zip wkTTS 1.1.0 (173 MB)]<br />
}}<br />
<br />
[[WormKit]] module adding text-to-speech to Worms Armageddon multiplayer games.<br />
<br />
While enabled, chat is automatically read aloud. A different voice is chosen for each player based on their nickname.<br />
<br />
== Installation ==<br />
# Download the the [https://github.com/greisane/wkTTS/releases latest release].<br />
# Unzip inside the game folder.<br />
# Enter command /tts while in game.<br />
<br />
== Usage ==<br />
The following commands are available in both lobby and game chat.<br />
<br />
;/tts<br />
: Toggle text-to-speech on or off.<br />
;/tts <volume><br />
: Set the speech volume from 1 to 100.<br />
;/shutup<br />
: Causes all speakers to stop talking.<br />
<br />
<br />
== Configuration ==<br />
wkTTS.ini can be opened with a text editor to change the default volume or enable other options.</div>Kobaryohttps://worms2d.info/?title=WkIndiMask&diff=28875WkIndiMask2021-08-13T14:29:36Z<p>Kobaryo: </p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
<br />
{{Software_infobox<br />
| name = wkIndiMask<br />
| developer = [[People/Plutonic|Plutonic]]<br />
| version = 9 August 2020<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.6.31.0 / 3.7.0.0 / 3.7.2.1 [Both] / 3.8.0 [Both] / 3.8.1 (unofficial) [Both]<br />
| language = C++<br />
| license = Restricted-source<br />
| download = [http://www.wormscc.co.uk/download/programs/files/wkIndiMask.7z Official version], [https://www.tus-wa.com/forums/worms-armageddon/wkindimask-4435/?action=dlattach;attach=195910 Unofficial 3.8.1 version]<br />
}}<br />
<br />
[[Image:IndiMask_demo.gif|thumb|230px|Animation: comparison of three levels of destructibility]]<br />
<br />
'''wkIndiMask''' is a module for [[WormKit]] that allows maps to be set up that have both destructible and indestructible parts to them.<br />
<br />
There are 3 'types' of terrain, Destructible, Indestructible and Tough (only removed when an explosion occurs that will remove the background soil texture. E.g The center part of Dynamite or Holy Hand Grenade)<br />
<br />
IndiMask settings for a map can be edited using [[MapGEN]] version 0.4.0 or later, or if you need more control, any paint package using the info below:<br />
<br />
All info is stored in the PNG palette for the map. In order to set up a map for wkIndiMask, you must first ensure the palette has a particular entry. The module will search for this entry when a game starts and activate or deactivate based on its presence. Because WA throws away unused map palette entries, it will have to exist somewhere on the map. 1 pixel under the water is fine.<br />
<br />
'''This colour is R:240, G:024, B:204. (<span style="background-color:#f018cc">&emsp;</span> #F018CC)'''<br />
<br />
After that, you can pick which colours are destructible or not using the least significant bit in the Red component of the colour. So essentially: <br />
<br />
'''If the Red component is even, you can destroy it; if it is odd, you can't.''' <br />
<br />
Further to that, the Green component is similarly used to decide if the colour is Tough. <br />
<br />
'''A colour that has odd for both Red and Green will be set as Tough'''.<br />
<br />
Tough terrain is only destroyed by a weapon where it would usually destroy the background layer.</div>Kobaryohttps://worms2d.info/?title=WormKit&diff=28872WormKit2021-08-13T10:29:18Z<p>Kobaryo: Moved IndiMask to compatible with 3.8.1</p>
<hr />
<div>{{ParentArticle|[[Software]]}}<br />
{{Software_infobox<br />
| icon = WormKit_icon.png<br />
| name = WormKit<br />
| developer = [[People/CyberShadow|CyberShadow]]<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = All versions<br />
| language = Delphi<br />
| license = Open-source<ref name="cybershadow-github"/><br />
}}<br />
<br />
'''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.<br />
<br />
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).<br />
<br />
Starting with W:A [[Worms_Armageddon_ReadMe_(English)/v3.7.0.0_Update|version 3.7.0.0]], the ability to load WormKit modules is included as a game option, which makes the loader itself obsolete.<br />
<br />
Some of the WormKit modules listed on this page have eventually become part of the base game. Such is the case, for example, with [[D3D9Wnd]] and [[RubberWorm]] in [[Worms_Armageddon_ReadMe_(English)/v3.8_Update|Update 3.8]].<br />
<br />
== Modules ==<br />
<br />
=== Original modules ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[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><br />
| In the CD edition, allows to override CD-only files with your versions.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[http://worms.thecybershadow.net/wormkit/wkSoundCardSelect.zip SoundCardSelect]'''<ref name="cybershadow-github" /><br />
| Choose the soundcard W:A should use for sound output.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[WormNAT2]]'''<br />
| Allows hosting games even if you're behind a router or firewall.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.6.28.0+<br />
| [[People/CyberShadow|CyberShadow]]<br />
|}<br />
<br />
=== Current modules by community ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkAntiLag.dll AntiLag]'''<br />
| A simple module to fix screen lags in-game by increasing the WA.exe process priority.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkBindKeys|BindKeys]]'''<br />
| A key mapper which works independently of the game's code and has a toggle key option.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Drey08|drey08]]<br />
|-<br />
| '''[[FkeyRearrange]]'''<br />
| Allows the user to redefine the order and content of weapons for each F hotkey.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1 {{and lower}}<br />
| [[People/boobl|boobl]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkIndiMask|IndiMask]]'''<br />
| It allows maps to have both destructible and indy areas by embedding data in the palette.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.0 {{and lower}} 3.8.1 via unofficial patch<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkKick38|Kick38]]'''<br />
| A kick module for 3.8. Allows host to kick players from in-game.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[terion]]<br />
|-<br />
| '''[[MapGEN]]'''<br />
| Allows to generate random PNG maps from the map editor.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[https://www.tus-wa.com/forums/worms-armageddon/wormkit-module-for-ingame-music-32542 NewWave]'''<br />
| Play custom music instead of the original in-game music.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/terion|terion]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkNV3Doff.dll NV3Doff]'''<br />
| Prevents the NVIDIA 3DVision from becoming active when using Direct3D 9.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRemapKeys|RemapKeys]]'''<br />
| A W:A-specific key remapper which doesn't affect chatting and works in-game only.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[SuperFrontendHD]]'''<br />
| Allows to run the menu screens at any screen resolution with higher-definition graphics.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7+<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkTerrainSync]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/nizikawa|nizikawa]]<br />
|-<br />
| '''[[wkWMDB]]'''<br />
| Allows the downloading of maps randomly from the WMDB site from within the editor, based on schemes and map size.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Plutonic|Plutonic]]<br />
|-<br />
| '''[[wkPin]]'''<br />
| Allows the weapon menu to remain open. Allows forcing the chat window to a set size.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.1<br />
| [[Tester7]]<br />
|-<br />
| '''[[wkFlamingHealthBars]]'''<br />
| Brings back the famous flaming team health bars and allows the use of custom health bars.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/terion|terion]]<br />
|}<br />
<br />
=== Developer modules, SDKs, debuggers ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkDetectFocusLoss.dll DetectFocusLoss]'''<br />
| Helpful to find what process(es) steal focus from the game (causing e.g. unwanted minimizations)<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[https://dump.thecybershadow.net/8405f07d0cfca4498c9d9bcc6075b860/wkMinidumpOnCtrlBreak.dll MinidumpOnCtrlBreak]'''<br />
| Helpful to find reasons of certain freezes. Creates dump by pressing Ctrl+Break.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPointerScan|PointerScan]]'''<br />
| A pointer scan made specifically for W:A. Helpful in the development of new WormKit modules.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0 {{and lower}}<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkVersionCheck.zip VersionCheck]'''<br />
| An example on C++ to verify the W:A version before hooking code.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkSample]]'''<br />
| The example open source module, which shows the development of WormKit modules.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/TheSCS|The SCS]]<br />
|}<br />
<br />
=== Not compatible with the latest release ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[wkKawooshKick|KawooshKick]]'''<br />
| An in-game kicking module, fully compatible with v3.7.2.1, supports kicking reasons.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkLobbyCmd|LobbyCmd]]'''<br />
| Allows to change the in-game resolution from a network game lobby to any value.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkPrivateCfg|PrivateCfg]]'''<br />
| Allows you to store all the W:A settings in an INI file instead of registry.<br />
| {{WA editions|cd}}<br />
| 3.7.0.0 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[Project X]]'''<br />
| Extends W:A with scripting, custom weapons and DirectX 9 rendering.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [http://px.worms2d.info Entuser]<br />
|-<br />
| '''[[wkRehost|Rehost]]'''<br />
| Allows reopening games when using a snooper to host.<br />
| {{WA editions|cd}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[ReplayShark]]'''<br />
| Allows to build a catalog of nice moments by pressing a button when something cool happens.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Glide|Glide]]<br />
|-<br />
| '''[http://files.steps.club/wa/wk/wkSnow.zip Snow]'''<br />
| A module to enable, customize and/or disable snow anytime, doesn't affect map generation.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[TrackMeBetter]]'''<br />
| Allows to tune the in-game camera tracking rectangle for object motion.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.2.1<br />
| [[People/StepS|StepS]]<br />
|}<br />
<br />
=== Obsolete (historical) ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | W:A version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[http://beta.team17.com/showthread.php?t=38762 ColorFix]'''<br />
| Fixes the color bug on Vista and Windows 7 by suspending the "explorer.exe" process.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[https://worms.thecybershadow.net/wormkit/wkAntiKeyboardHook.zip AntiKeyboardHook]'''<ref name="cybershadow-github" /><br />
| Stop MS Windows (2000 - 8.1) 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><ref name="akh-obsolete">This module is now obsolete on Windows 10 (because the root cause has been fixed by Microsoft). This module was never necessary for non-CD editions of the game, and there exists a registry-based fix that is preferable instead.</ref><br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkPathOverride|PathOverride]]'''<br />
| Modifies the registry to use WormKit.exe for URLs (like "wa://") and replay files.<br />
| {{WA editions|cd}}<br />
| All<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[wkRandomMap|RandomMap]]'''<br />
| Allows you to download random maps from [[WMDB]] directly from the map editor.<br />
| {{WA editions|cd}}<br />
| 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><br />
| [http://shadowtheage.narod.ru ShadowTheAge]<br />
|-<br />
| '''[http://tim32.org/~muzer/t17-archive/forum.team17.com/archive/index.php/t-57737.html wndmode]'''<br />
| DirectDraw windowed mode running in a wrapper.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/menopem|menopem]], [[People/VEG|VEG]],<br>[[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[wkUseDesktopWindow|UseDesktopWindow]]'''<br />
| A module which in future will help to run WWP and older W:A on Wine.<br />
| {{WA editions|cd|steam|gog}}<br />
| All<br />
| [[People/Muzer|Muzer]]<br />
|-<br />
| '''[[D3D9Wnd]]'''<br />
| A Direct3D 9-based windowed mode, which works natively and includes some cool features.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.7.x<br />
| [[People/Kawoosh|Kawoosh]], [[People/StepS|StepS]]<br />
|-<br />
| '''[[RubberWorm]]'''<br />
| Extends the W:A physics engine with new options.<br />
| {{WA editions|cd|steam}}<br />
| 3.7.2.1 {{and lower}}<br />
| [[People/Pisto|Pisto]], [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[[WA_Localizer|Localizer]]'''<br />
| Allows you to translate W:A fully (frontend, ingame, etc), goes with an editor.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://myfiles.my1.ru/wa/wk/wkPXColorPwnage.dll PXColorPwnage]'''<br />
| Fixes the Darker team colour scheme when PX is enabled.<br />
| {{WA editions|cd}}<br />
| 3.6.31.0<br />
| [[People/Kawoosh|Kawoosh]]<br />
|-<br />
| '''[http://worms.cinus.org/wkcinuskick CinusKick]'''<br />
| An analog to wKick module for W:A update 3.6.29.0.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [http://worms.cinus.org Cinus]<br />
|-<br />
| '''[[JetFix]]'''<br />
| Provides a workaround for the jetpack bug when using [[BattyRope]] or [[TestStuff]].<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[LaserFix]]'''<br />
| A fix for the [[Laser Sight]] desynchronization bug in v3.6.29.0, and some nice features.<br />
| {{WA editions|cd}}<br />
| 3.6.29.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[http://forum.team17.com/showthread.php?t=35805 wKick]'''<br />
| Allows you to kick people in-game by typing a command in the chat. Works only on 3.6.28.0.<br />
| {{WA editions|cd}}<br />
| 3.6.28.0<br />
| [[People/Pisto|Pisto]]<br />
|-<br />
| '''[[wkMagic]]'''<br />
| First proof-of-concept module that allowed game logic code modification in online games.<br />
| {{WA editions|cd}}<br />
| 3.6.26.5<br />
| [[People/CyberShadow|CyberShadow]]<br />
|-<br />
| '''[[wkTerrain]]'''<br />
| Allows to specify custom terrains for use with the map generator.<br />
| {{WA editions|cd|steam|gog}}<br />
| 3.8.x<br />
| [[People/xKoweKx|xKoweKx]], [[People/terion|terion]]<br />
|}<br />
<br />
=== For Worms 2 / WWP ===<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="width:164px" | Name<br />
! style="none" | Short description<br />
! style="width:68px" | Compat.<br />
! style="width:100px" | Version<br />
! style="width:100px" | Developer<br />
|-<br />
| '''[[ReSolution]]'''<br />
| 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.<br />
| {{software|W2|WWP}}<br />
| 1.05 (W2)<br>1.0x (WWP)<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[DDShot]]'''<br />
| Allows to take screenshots in DirectDraw games (via the Pause key) or dump shots of all surfaces (via Alt+Pause).<br />
| {{software|W2|WWP|WA}}<br />
| All<br />
| [[People/StepS|StepS]]<br />
|-<br />
| '''[[fkNetcode]]'''<br />
| Fixes netcode related issues in the Worms 2 frontend, primarily resolving a proper external IP address for hosting games.<br />
| {{software|W2}}<br />
| 1.05/1.07 (Frontend)<br />
| [[User:Pac-Man|Pac-Man]]<br />
|-<br />
| '''[http://www.gog.com/forum/worms_series/plugin_windowed_mode_for_worms_2_improve_windows_8_performance W2 Windowed Mode]'''<br />
| Allows to run Worms 2 in a window and fixes Windows 8+ performance issues.<br />
| {{software|W2}}<br />
| All<br />
| See "wndmode"<br />
|-<br />
| '''[http://www.tus-wa.com/?topic=21030 WWP Windowed Mode]'''<br />
| Fixes compatibility with all modern systems and drivers and allows to use windowed mode.<br />
| {{software|WWP}}<br />
| All<br />
| See "wndmode"<br />
|}<br />
<br />
== History ==<br />
<br />
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.<br />
<br />
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.<br />
<br />
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.<br />
<br />
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].<br />
<br />
In July 2020, [[FrontendKitWS]] was created to patch issues specifically related to the [[Worms 2]] frontend, as it does not support loading modules through WormKitDS.<br />
<br />
== See also ==<br />
* [[WormKitDS]] loads modules for Worms 2 (in-game), W:A (pre-3.7), and Worms World Party<br />
* [[FrontendKitWS]] loads modules for Worms 2 (frontend)<br />
<br />
== Notes ==<br />
<references/><br />
__NOTOC__</div>Kobaryohttps://worms2d.info/?title=WkIndiMask&diff=28871WkIndiMask2021-08-13T10:26:25Z<p>Kobaryo: Added unofficial 3.8.1 version</p>
<hr />
<div>{{lowercase title}}<br />
{{ParentArticle|[[WormKit]]}}<br />
<br />
{{Software_infobox<br />
| name = wkIndiMask<br />
| developer = [[People/Plutonic|Plutonic]]<br />
| version = 9 August 2020<br />
| games = [[Worms Armageddon|W:A]]<br />
| waver = 3.6.31.0 / 3.7.0.0 / 3.7.2.1 [Both] / 3.8.0 [Both] / 3.8.1 (unofficial) [Both]<br />
| language = C++<br />
| license = Restricted-source<br />
| download = [http://www.wormscc.co.uk/download/programs/files/wkIndiMask.7z Official version], [https://www.tus-wa.com/forums/worms-armageddon/wkindimask-4435/?action=dlattach;attach=195909 Unofficial 3.8.1 version]<br />
}}<br />
<br />
[[Image:IndiMask_demo.gif|thumb|230px|Animation: comparison of three levels of destructibility]]<br />
<br />
'''wkIndiMask''' is a module for [[WormKit]] that allows maps to be set up that have both destructible and indestructible parts to them.<br />
<br />
There are 3 'types' of terrain, Destructible, Indestructible and Tough (only removed when an explosion occurs that will remove the background soil texture. E.g The center part of Dynamite or Holy Hand Grenade)<br />
<br />
IndiMask settings for a map can be edited using [[MapGEN]] version 0.4.0 or later, or if you need more control, any paint package using the info below:<br />
<br />
All info is stored in the PNG palette for the map. In order to set up a map for wkIndiMask, you must first ensure the palette has a particular entry. The module will search for this entry when a game starts and activate or deactivate based on its presence. Because WA throws away unused map palette entries, it will have to exist somewhere on the map. 1 pixel under the water is fine.<br />
<br />
'''This colour is R:240, G:024, B:204. (<span style="background-color:#f018cc">&emsp;</span> #F018CC)'''<br />
<br />
After that, you can pick which colours are destructible or not using the least significant bit in the Red component of the colour. So essentially: <br />
<br />
'''If the Red component is even, you can destroy it; if it is odd, you can't.''' <br />
<br />
Further to that, the Green component is similarly used to decide if the colour is Tough. <br />
<br />
'''A colour that has odd for both Red and Green will be set as Tough'''.<br />
<br />
Tough terrain is only destroyed by a weapon where it would usually destroy the background layer.</div>Kobaryo