Difference between revisions of "WkTerrainSync"

Revision as of 19:24, 9 February 2021

Domestic Terrain

wkTerrainSync is a module for WormKit that allows additional W:A terrains to be installed and selected in the Map editor

It makes it easy for terrains such as Dinos and Domestic (which are present on the WWP CD) to be installed and played with W:A.

It superseded WkTerrain adding new features such as data synchronization for network games and sprite addition/replacement.

For information on how to put together your own custom terrain, see the Terrain Creation Guide.

Usage

A valid terrain directory contains two files:

• Level.dir, the main graphics directory which contains all the texture assets. This file can be read and edited using the WA Directory Editor.
• TEXT.IMG, this represents the texture thumbnail as shown in the map editor.

It's also possible to include a customized Water.dir and should be place in the terrain directory.

• wkTerrainSync does not require any special configuration or user interaction.
• 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.
• When generating a random map by clicking on map thumbnail, the game selects a random terrain from all available terrains.
  • To limit this selection to only custom terrains, hold CTRL key and click on the thumbnail.
  • To limit this selection to only default terrains, hold ALT key and click on the thumbnail.
• Online play with a mix of wkTerrain38 and wkTerrainSync players is not supported. In such case both wkTerrain38 and wkTerrainSync will refuse to load custom terrain maps and wkTerrainSync will print warning messages in lobby chat
• Downloaded terrain directories are stored as "Name #MD5checksum" to avoid file conflicts
• Incomplete file transfers are stored with .part suffix to prevent adding incomplete downloads to the terrain list
• To troubleshoot the module, enable dev console in .ini file and examine the logged messages

Features

Data synchronization features:

• Custom network protocol integrated with WA's original network code - this module works seamlessly with WormNAT2 and direct hosting
• Terrains are now referenced by their MD5 hash instead of ID - play online games regardless of your terrain list order and terrain directory names
• File transfers - missing terrain files are automatically downloaded from the host player
• Terrain metadata is embedded directly in .wagame replay files - replay files will work even when terrain list changes or files are renamed

Terrain customization features:

• 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
• 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
• 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
• 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

Custom terrains

Here are some terrains available to use. Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.

You can click at the hyperlink below the island previews to open a full-size screenshot of the terrain, with background, debris and all terrain properties.

• 

  Arachnophobia by
  sbs and Conejo

• 

  Arcade by
  Ducky

• 

  Candy from MapGEN

• 

  Cosmic by
  King-Gizzard

• 

  Dinos from WWP

• 

  Domestic from WWP

• 

  Ganja by
  King-Gizzard

• 

  Tetris by SiD

• 

  Windows 95 by Ducky

• 

  'DIY' from Worms DC by Ducky

Notes

Those using the CD version of W:A will require FileOverride to use this module.