Worms2server/README.md

49 lines
3.4 KiB
Markdown
Raw Normal View History

2017-04-17 21:10:34 +03:00
# Worms
2019-01-13 00:25:12 +03:00
The following .NET libraries in this repository can access and modify file formats of second generation Worms games
developed by Team17:
2017-04-17 23:01:27 +03:00
2020-06-18 17:04:52 +03:00
* `Syroot.Worms`: Main library featuring common formats (like a data archive).
* `Syroot.Worms.Worms2` (W2): Worms 2 formats.
* `Syroot.Worms.Armageddon` (WA): Worms Armageddon formats.
* `Syroot.Worms.Armageddon.ProjectX` (PX): Worms Armageddon ProjectX add-on formats.
* `Syroot.Worms.WorldParty` (WWP): Worms World Party formats.
* `Syroot.Worms.Mgame`: Online Worms (OW) and Worms World Party Aqua (WWPA) formats (Asia licensed clients).
2017-04-17 23:01:27 +03:00
2020-07-01 20:22:17 +03:00
## File formats
2020-07-01 20:32:29 +03:00
The following file formats are understood by the specified libraries, sorted by extension.
Formats which are listed but not yet supported are planned to be implemented at a later date.
| Extension | Description | Games | Library | Load | Save |
|-----------|-------------------|:-----------:|------------------------------------|:----:|:----:|
| BIT | Monochrome Map | WA, WWP | `Syroot.Worms.Armageddon` | ❌ | ❌ |
| DAT | Mission | W2 | `Syroot.Worms.Worms2` | ❌ | ❌ |
| LAND.DAT | Land Data | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ |
| DIR | Archive | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ |
| IGD | Image Container | WWPA | `Syroot.Worms.Mgame` | ✔ | ❌ |
| IMG | Image | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ |
| KSF | Image Container | OW | `Syroot.Worms.Mgame` | ✔ | ❌ |
| LEV | Generated Map | WA, WWP | `Syroot.Worms.Armageddon` | ✔ | ✔ |
| LEV | Monochrome Map | W2 | `Syroot.Worms.Worms2` | ❌ | ❌ |
| LPD | Interface Layout | WWPA | `Syroot.Worms.Mgame` | ✔ | ❌ |
| OPT | Scheme Options | W2 | `Syroot.Worms.Worms2` | ✔ | ✔ |
| PAL | Palette | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ |
| PXL | Project X Library | WA+PX | `Syroot.Worms.Armageddon.ProjectX` | ✔ | ✔ |
| PXS | Project X Scheme | WA+PX | `Syroot.Worms.Armageddon.ProjectX` | ✔ | ✔ |
| ST1 | Team Container | W2 | `Syroot.Worms.Worms2` | ✔ | ✔ |
| WAGAME | Replay | WA | `Syroot.Worms.Armageddon` | ❌ | ❌ |
| WAM | Mission | WA, WWP | `Syroot.Worms.Worms2` | ❌ | ❌ |
| WEP | Scheme Weapons | W2 | `Syroot.Worms.Worms2` | ✔ | ✔ |
| WGT | Team Container | WA | `Syroot.Worms.Armageddon` | ✔ | ✔ |
| WSC | Scheme | WA, WWP | `Syroot.Worms.Armageddon` | ✔ | ✔ |
| WWP | Team Container | WWP | `Syroot.Worms.WorldParty` | ✔ | ✔ |
2020-07-01 20:22:17 +03:00
## Tools
2020-06-18 17:04:52 +03:00
* `Syroot.Worms.Mgame.Launcher`: Creates a fake launch configuration to start OW or WWPA clients with.
* `Syroot.Worms.Mgame.GameServer`: Simulates a server communicating with OW or WWPA clients (WIP).
2017-12-07 17:21:34 +03:00
2020-07-01 20:22:17 +03:00
## Availability
The libraries are available on [NuGet](https://www.nuget.org/packages?q=Syroot.Worms).