Worms2server/README.md

# Worms
The following .NET libraries in this repository can access and modify file formats of second generation Worms games
developed by Team17:

* `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).

## Supported file formats

| Description       | Extension |    Games    | Load | Save |
|-------------------|:---------:|:-----------:|:----:|:----:|
| Archive           | DIR       | W2, WA, WWP | Yes  | Yes  |
| Image             | IMG       | W2, WA, WWP | Yes  | Yes  |
| Land Data         | LAND.DAT  | W2, WA, WWP | Yes  | Yes  |
| Mission           | DAT       | W2          | No   | No   |
| Mission           | WAM       | WA, WWP     | No   | No   |
| Generated Map     | LEV       | WA, WWP     | Yes  | Yes  |
| Image Container   | KSF       | OW          | Yes  | No   |
| Image Container   | IGD       | WWPA        | Yes  | No   |
| Interface Layout  | LPD       | WWPA        | Yes  | No   |
| Monochrome Map    | LEV       | W2          | No   | No   |
| Monochrome Map    | BIT       | WA, WWP     | No   | No   |
| Palette           | PAL       | W2, WA, WWP | Yes  | Yes  |
| Project X Library | PXL       | WA+PX       | Yes  | Yes  |
| Project X Scheme  | PXS       | WA+PX       | Yes  | Yes  |
| Replay            | WAGAME    | WA          | No   | No   |
| Scheme            | WSC       | WA, WWP     | Yes  | Yes  |
| Scheme Options    | OPT       | W2          | Yes  | Yes  |
| Scheme Weapons    | WEP       | W2          | Yes  | Yes  |
| Team Container    | ST1       | W2          | Yes  | Yes  |
| Team Container    | WGT       | WA          | Yes  | Yes  |
| Team Container    | WWP       | WWP         | Yes  | Yes  |

## Available tools

* `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).

## Support
The libraries are available as separate [NuGet packages](https://www.nuget.org/packages?q=Syroot.Worms).