Difference between revisions of "RubberWorm"

Revision as of 11:29, 14 October 2012

RubberWorm
Developer:	Pisto, Kawoosh
Latest version:	RubberWorm3x (3.6.31.0): 0.0.1.12 / 13 October 2012 Original by Pisto (3.6.29.0): 0.7.32 / 3 August 2008
Supported games:	W:A
Supported W:A version:	3.6.31.0, 3.6.29.0
Language:	C
License:	Partially open-source
Download:	3.6.31.0: Kawoosh's DLL StepS' installer 3.6.29.0 (original): Pisto's dll, installer Source code 1.0 alpha preview

RubberWorm (or wkRubberWorm) is a module for WormKit that can modify parts of the Worms Armageddon physics to create WormPot-like effects, and adapts some features of wkMagic to the 3.6.29.0 and 3.6.31.0 versions. It was originally released by Pisto on 6 April 2008, and then ported by Kawoosh to the latest beta update with several new features.

RubberWorm's effects are applied to the game when certain scheme settings are set to certain values. These settings are normally unused, such as crate probabilities for superweapons. As such, only an external scheme editor can create schemes that will enable RubberWorm effects, though RubberWorm does also provide a chat command interface allowing a host to enable RubberWorm effects in the lobby of a WormNET game. The scheme can then be extracted from the replay afterwards.

For a complete and trusted online play, all players must run WA through WormKit or with WormKitDS, and should have the same version of the RubberWorm dll file.

General Info

Installation and use

As any WormKit module, it has to be placed in the W:A main folder (or you can use the installer), and the game must be run through WormKit or with WormKitDS (included in the installer). Changes to the game are applied only when any feature of RubberWorm is enabled.

Source code

Original wkRubberWorm is written in C, and a part of the source code, lacking of addresses and structs (as wkMagic), is public for demonstrative purpose. The RubberWorm3x by [People/Kawoosh|Kawoosh] was done by reverse-engineering the original RubberWorm, and its code is in C++.

3.6.31.0 custom version

There is a 3.6.31.0-compatible RubberWorm version, modified by Kawoosh to work on 3.6.31.0. It has all basic features of old RubberWorm, KaosMod, TrastulloPerAtrox and some of LaserFix and will not make desyncs when playing with an old WA+RubberWorm user*. The same concerns replays - you can safely view old 3.6.29.0 RubberWorm replays using this version. Read more here.

*If none of the new features, listed below, is enabled. Some of them were also part of old LaserFix module, and so they are compatible.

New features

In-game chat

/colormod - team-colored rope, outlines of worm bars and lasersight. Best with darker team colour scheme (PX users will have to install wkPXColorPwnage to make darker colour scheme work).

Pre-game lobby chat interface

/wdca - weapons don't change automatically.

Controlled by the seventh bit of the crate probability of Mole Squadron (add 64 to enable).

/ope - enables a special game mode in which all objects can be pushed by explosions. Like ldet and sdet, it is stored in the same byte as 6th bit.

Controlled by the sixth bit of the crate probability of Mole Squadron (add 32 to enable).

/flames - allows you to enlarge the number of max possible flames at the map, up to 25500. Activated by the Scales of Justice crate probability parameter.

Flames is set by the crate probability of Scales of Justice (the number of max possible flames will be the chosen value multiplied by 100).

/kaosmod[1/2/3/4/5] - this mod is only needed for kaos players, as it changes the utilities crate probabilities percentages, needed for a kaos scheme and league.

Controlled by the crate probability of Earthquake (add 16 for kaosmod1, 48 for kaosmod2, 80 for kaosmod3, 112 for kaosmod4 or 144 for kaosmod5 to enable).

An explaination table is shown below.

/speed[value] - speed limit for roping and objects (16-default, 32-ts, 255-nolim (like in ts3))

Speed is set by the crate probability of Mine Strike.

/ts8 - TS8 aliase command (version164) which can be directly integrated into the scheme file.

Activated by a value of 164 (in decimal notation) of the crate probability of Select Worm.

/fuseex - extends the selectable fuse up to 9 for grenades, bananas, mad cow herds, etc.

Controlled by the eighth bit of the crate probability of Mole Squadron (add 128 to enable).

/swat - select worm anytime during the turn, let it be a mid-air, falling, sliding, plopping or else! If the Wormselect option is enabled in the scheme, swat will be working during the whole match. If the Wormselect option is disabled in the scheme, swat can be called with the Select Worm weapon, and will last till the end of the turn (like an utility).

Controlled by the first bit of the crate probability of MB Bomb (add 1 to enable).

/knock[value] - custom knocking force. Using it you can set any force from 1 to 255 (where 100 is the normal, 254 is the max and 255 forces no knocking). This does not depend on a channel/TS/batty. Note: like always, a knock is treated by W:A as a "rope knock" until you lose your turn (lose control), i.e. losing turn by rolling on landscape and then touching a worm doesn't qualify as a rope knock.
1 .............. extremely low force
100 ............ normal force
200 ............ 2x knocking force
254 ............ 2.54x knocking force
255 ............ force no rope knocking

Knock force is set by the crate probability of Super Banana Bomb.

These features have been ported from italian wkTrastulloPerAtrox.dll module:

/reaim: auto reaiming at the turn start

Controlled by the crate probability of Earthquake (add 1 to enable).

/cira: circular aiming (ts-like)

Controlled by the crate probability of Earthquake (add 2 to enable).

/alp: antilock power (ts-like)

Controlled by the crate probability of Earthquake (add 4 to enable).

/usw: unlock sdet weapons (armageddon, earthquake, nuketest)

Controlled by the crate probability of Earthquake (add 8 to enable).

Features

Bouncing worms

The original purpose of RubberWorm. Every time a worm hits an object or the terrain (in any direction), it bounces off of it. If it's during a rope roll, it can continue roping, and it never takes fall damage or loses the turn. The feature is always off if the worm is flying for a jump.

The worms' "boing" sound can switched on/off typing in the in-game chat /boing (not in RubberWorm3x).

Worm bounciness (or technically, the coefficient of restitution) is determined by the quotient of the value for the Armageddon crate probability divided by 255. For example, if the value is set to 0, the coefficient of restitution is 0, resulting in no bounce. If 255, the coefficient is 1, resulting in a perfectly elastic collision (the worm bounces with the same speed with which it hit the object or terrain).

Gravity modifications

Gravity can be made stronger or weaker, eliminated or even reversed. When reversed, a worm can stand on its head and shoot, but walking is obviously buggy. Also, should an object encounter no obstacle and fall into the sky, it will be sent to water when it reaches a certain height, otherwise it would block the game indefinitely.

Activated by the crate probability of the Mail Strike, if the high bit (eighth bit) is clear. The other bits control the strength of gravity, from -64 to +63 in two's complement format (the seventh bit is the sign bit); a value of 0 or 12 results in default gravity.

Central gravity (black hole mode)

Gravity points towards the center of the map, or away from it (anti-gravity). These modes can either be proportional, where gravity is stronger near the center of the map, or constant, where gravity is the same strength for all locations.

In black hole mode, the object may either start a steady orbit or fall in the middle of the map and never stop flying: to avoid the first case objects that don't explode after some seconds (like worms, mines, crates and barrels) have a very small air viscosity value (see below); for the second case, objects nearer than 15 pixel to the center are sent to water.

Anti-gravity has a similar safeguard to reversed gravity (see above).

The strength of the gravity can be adjusted.

Activated by the crate probability of the Mail Strike. The high bit (eighth bit) enables black hole mode; the seventh bit enables proportional mode; the other bits control the strength of the black hole's gravity, from -32 to +31 in two's complement format (the sixth bit is the sign bit).

Air viscosity

Objects flying through the air lose speed up to a steady velocity, determined by gravity and wind (imagine throwing a rock in the water). Some objects, such as crates, graves, barrels, parachuting worms, and Mail Strike letters, will not experience this effect. It is adjustable: a value of 63 makes the air pasty as water.

Activated by the crate probability of the Concrete Donkey. A higher value produces a stronger effect. If the value is odd, the effect will apply to worms as well as objects.

Wind influence

Like air viscosity, it can be applied to only objects or worms too, but never to those objects (like bazooka) that are already influenced by wind or crates, graves, barrels. How much the wind moves the objects is adjustable.

Activated by the crate probability of the Suicide Bomber. A higher value produces a stronger effect, with the highest value (255) corresponding to the wind susceptibility of the Bazooka. If the value is odd, the effect will apply to worms as well as objects.

Anti worm sink

If activated, a worm that hits the water is prevented from drowning and instead teleported to the last location where it has been motionless. The turn does not end. If the teleport results in the worm falling and hitting water again (for example, if the terrain has since been destroyed by a weapon), it drowns normally.

This feature is activated by a non-zero value for the crate probability of the French Sheep Strike.

Crate finder

Arrows point to crates, as they do in certain missions. This feature can give a player an advantage if other players do not have RubberWorm, so a chat message is used to alert other players to its use.

Type /arrows in the in-game chat to activate this.

Friction modifications

Currently, the velocity of a worm is slowed by 4% each frame that a worm slides along the terrain. This is given by multiplying velocity by F*0.01, where the default F value is 96. A lower value results in a higher degree of friction, with F=0 reducing velocity to zero immediately (infinite friction). Values between 96 and 100 give slippier terrains, while a value of 100 results in no friction. Values above 100 will result in the worm's velocity actually increasing as it slides.

The friction value is stored in the crate probability of the Salvation Army.

Shot doesn't end turn, Loss of control doesn't end turn, Fire doesn't pause timer, Improved rope, Continuous crate shower

To edit these options, start with a value of zero and add the corresponding number for each option you want to enable (listed below). Then set the crate probability of the Mole Squadron to the resulting sum.

Shot doesn't end turn

Firing a weapon doesn't end the player's turn. There's no retreat time and you can't control any weapon (such as Sheep or Supersheep) when turn time runs out.

Controlled by the first bit of the crate probability of Mole Squadron (add 1 to enable).

Loss of control doesn't end turn

When activated, control of the active worm will not be lost in any circumstances (fall from a great height, weapon explosion, etc) except death.

Controlled by the second bit of the crate probability of Mole Squadron (add 2 to enable).

Fire doesn't pause timer

The timer doesn't pause while firing any weapon. Useful with Shot doesn't turn, because without it one could extend his turn time for a very long time using drill or blow torch, for example.

Controlled by the third bit of the crate probability of Mole Squadron (add 4 to enable).

Improved rope

Changes the rope physics to simulate Worms 2 (higher accelleration, 162 degrees of shooting)

Controlled by the fourth bit of the crate probability of Mole Squadron (add 8 to enable).

Continuous crate shower

Normally, the game checks between turns the crate probability settings, and determines if and which crate must be spawned. With this feature, you can force the game to do this job every 5 seconds, also during turns. If you want a crate shower like Worms World Party, use SchemeEddy to check that the probability of no crate falling per turn is 0%. Keep in mind that the WWP crate shower spawns a completely random crate, that is it doesn't check the probability of each single weapon (that's why you can grab even Surrender).

Controlled by the fifth bit of the crate probability of Mole Squadron (add 16 to enable).

Version override

There are many engine version that come with the last update, and some of them may be interesting for their different behaviour. You shouldn't emulate the earliest versions of the 3.x, as they may lead to crashes (like, for not supporting the new scheme format, colored/big maps).

Version is set by the crate probability of Select Worm.

For version numbers, see WA versions list.

Crate rate variability

Controls the number of crates that appear per turn. When a value of Crate Rate exists, the Crate Count automatically will be turned on.

Set by the crate probability of the Indian Nuclear Test. The value 1 only will turn on the Crate Count

Crate limit variability

Controls the number of crates that can exist on the map at any one time (five at default)

Set by the crate probability of the Magic Bullet.

Chat command interface

These commands can be used in the host/join lobby. Omitting the parameter either activates the feature with a default value, or sets it off.

Future plans

Pisto gave up coding RubberWorm, though version 1.0 has been developed inconstantly for over a year. He lost interest in Worms, but also in programming in general. The source code of Kawoosh's RubberWorm31 0.0.1.11, RubberWorm 0.7 (a version compatible with the old 3.6.28.0 update), and of the never going to be 1.0 has been given to Deadcode: his aim is to add the emulation of RubberWorm in the official updates. This is going to happen in the next update after 3.6.31.0.

Pre-release with aliased-bounces

On 26th August 2009 a test build of RubberWorm 1.0 has been released. The reason for sharing it is to show some of the new features, mainly aliased-bounce. It allows to emulate the real behaviour of an object colliding with an object with a slope, a great lack of the Worms Armageddon default engine.

See also

• Project X
• RubberWorm3x discussion thread
• RubberWorm discussion thread
• RubberWorm 1.0 preview