Difference between revisions of "WkTerrainSync"
From Worms Knowledge Base
King-Gizzard (Talk | contribs) (→Custom terrains) |
(the gallery format is really good, and perfect for a compilation like this. I think this ought to replace the table altogether. here's a preview of what i think it could look like (caption changed for Arachnophobia)) |
||
| Line 120: | Line 120: | ||
|} | |} | ||
| − | + | ==Gallery== | |
| − | <!-- If you'd like to create an island preview | + | |
| + | <!-- If you'd like to create an island preview picture that matches the same "standard" of size and ratio of the other pictures here, --> | ||
<!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --> | <!-- you can check out this guide: https://www.notion.so/W-A-wkTerrain-island-previews-d338f82236da46e0a861b01b1c6a700c --> | ||
| − | + | <!-- Format your entry as follows: --> | |
| − | <gallery mode="nolines" > | + | <!-- 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 --> |
| − | File:Arachnophobia.png|Arachnophobia | + | |
| − | < | + | Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties. |
| − | < | + | |
| + | <gallery mode="nolines" widths="250px" heights="250px"> | ||
| + | |||
| + | 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 | ||
| + | |||
File:Arcade.png|Arcade by <br>Ducky | File:Arcade.png|Arcade by <br>Ducky | ||
File:Camping_Small.png|Camping by <br>King-Gizzard|link=Media:Camping_1080.png | File:Camping_Small.png|Camping by <br>King-Gizzard|link=Media:Camping_1080.png | ||
Revision as of 13:49, 13 July 2021
(Up to WormKit)
| wkTerrainSync | |
|---|---|
| Developer: | nizikawa |
| Latest version: | v1.1.0a (2 May 2021) |
| Supported games: | W:A |
| Supported W:A version: | 3.8.x |
| Language: | C++ |
| License: | Open Source |
| Website: | TUS thread |
| Download: | [1] |
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.
Contents
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
- 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.
Custom terrains
Here are some terrains available to use. Download, extract and place the terrain folder into Worms Armageddon/DATA/Level.
| Name | Author | Download | Notes | Submission / Last update |
|---|---|---|---|---|
| Arachnophobia | sbs and Conejo | TUS file | art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027 | 2020-12-31 |
| Arcade | Ducky | TUS file | Participation of oScarDiAnno who made the "worm plush grabbed by a claw" object | 2021-01-24 |
| Blood | Korydex | TUS file | 2021-01-04 | |
| Camping | King-Gizzard | TUS file | 2021-05-16 | |
| Candy | Unknown | TUS file | created using MapGEN Candy theme | 2018 |
| Chocolate | King-Gizzard | TUS file | 2021-07-13 | |
| Cosmic | King-Gizzard | TUS file | 2020-12-22 | |
| Diablo | Korydex | TUS file | 2021-01-06 | |
| Dinos | Team17 | TUS file | taken from WWP CD | 2018 |
| Domestic | Team17 | TUS file | taken from WWP CD | 2018 |
| Electronics | Conejo | TUS file | 2020-12-05 | |
| Egypt | ARTemych and SiD | TUS file | Crafted by SiD. Original ARTemych's art from https://www.wmdb.org/28412 | 2020-10-22 |
| Fimbulwinter | 1gor Melitonov | TUS file | 2021-01-10 | |
| Ganja | King-Gizzard | TUS file | 2020-09-24 | |
| Low Poly | Conejo | TUS file | 2021-01-06 | |
| MulheresBarbadas | Conejo | TUS file | Mulheres Barbadas ART > https://mulheresbarbadas.tumblr.com/ | 2021-06-03 |
| Origami | Conejo | TUS file | 2020-12-05 | |
| Picture City | gray | TUS file | from Rayman 1. Includes a custom water file. | 2021-03-24 |
| Prehistoria | Korydex | TUS file | Lost Vikings | 2021-01-02 |
| Sushi | Conejo | TUS file | 2021-06-07 | |
| Tetris | SiD | TUS file | 2018 | |
| Windows 95 | Ducky | [2], TUS file | 2020-09-01 | |
| Worms DC 'DIY' | Ducky | [3], TUS file | 2020-09-01 | |
| Worms Reloaded terrain pack | Team17, nizikawa, King-Gizzard | TUS file | Contains: Arabian, Arctic, Hawaii, Jurassic, Space, Wild West | 2021-07-01 |
| Worms United terrain pack | Team17, nizikawa | TUS file | Contains: Geiger, Graveyard, Hell, Junk, Mars, Money, Nam, Snow, Warzone | 2021-04-03 |
Gallery
Click the preview picture to view a full-size screenshot of the terrain (where available), with background, debris and all terrain properties.
Arachnophobia
by sbs and Conejo
TUS file
2020-12-31
Art by sbs, crafted by Conejo. Source: https://www.wmdb.org/35027
Arcade by
Ducky
Camping by
King-Gizzard
Candy from MapGEN
Chocolate by
King-Gizzard
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
Electronics by Conejo
Lowpoly by Conejo
Mulheresbarbadas by Conejo
Sushi by Conejo
Origami by Conejo
Notes
Those using the CD version of W:A will require FileOverride to use this module.
