Update README.md

This commit is contained in:
Ray Koopa 2020-07-01 17:36:34 +00:00
parent 7e13af88d1
commit 9548855a8e

View File

@ -1,21 +1,9 @@
# Worms # 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). This repository hosts .NET libraries which can import, modify, and export the following file formats of second generation Worms games developed by Team17 or Mgame:
* `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).
## File formats
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 | | Extension | Description | Games | Library | Load | Save |
|-----------|-------------------|:-----------:|------------------------------------|:----:|:----:| |-----------|-------------------|-------------|------------------------------------|:----:|:----:|
| BIT | Monochrome Map | WA, WWP | `Syroot.Worms.Armageddon` | ❌ | ❌ | | BIT | Monochrome Map | WA, WWP | `Syroot.Worms.Armageddon` | ❌ | ❌ |
| DAT | Mission | W2 | `Syroot.Worms.Worms2` | ❌ | ❌ | | DAT | Mission | W2 | `Syroot.Worms.Worms2` | ❌ | ❌ |
| LAND.DAT | Land Data | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ | | LAND.DAT | Land Data | W2, WA, WWP | `Syroot.Worms` | ✔ | ✔ |
@ -38,6 +26,8 @@ Formats which are listed but not yet supported are planned to be implemented at
| WSC | Scheme | WA, WWP | `Syroot.Worms.Armageddon` | ✔ | ✔ | | WSC | Scheme | WA, WWP | `Syroot.Worms.Armageddon` | ✔ | ✔ |
| WWP | Team Container | WWP | `Syroot.Worms.WorldParty` | ✔ | ✔ | | WWP | Team Container | WWP | `Syroot.Worms.WorldParty` | ✔ | ✔ |
Implementation of formats listed above as unsupported is planned for a later date.
## Tools ## Tools
* `Syroot.Worms.Mgame.Launcher`: Creates a fake launch configuration to start OW or WWPA clients with. * `Syroot.Worms.Mgame.Launcher`: Creates a fake launch configuration to start OW or WWPA clients with.