Update README.md

This commit is contained in:
Ray Koopa 2020-07-01 17:22:17 +00:00
parent cc0ccaae7d
commit ed4b69d4ad

View File

@ -9,36 +9,39 @@ developed by Team17:
* `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
## File formats
Support for the following file formats is currently available (✔) or planned (❌).
| 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 |
| Archive | DIR | W2, WA, WWP | ✔ | ✔ |
| Image | IMG | W2, WA, WWP | ✔ | ✔ |
| Land Data | LAND.DAT | W2, WA, WWP | ✔ | ✔ |
| Mission | DAT | W2 | ❌ | ❌ |
| Mission | WAM | WA, WWP | ❌ | ❌ |
| Generated Map | LEV | WA, WWP | ✔ | ✔ |
| Image Container | KSF | OW | ✔ | ❌ |
| Image Container | IGD | WWPA | ✔ | ❌ |
| Interface Layout | LPD | WWPA | ✔ | ❌ |
| Monochrome Map | LEV | W2 | ❌ | ❌ |
| Monochrome Map | BIT | WA, WWP | ❌ | ❌ |
| Palette | PAL | W2, WA, WWP | ✔ | ✔ |
| Project X Library | PXL | WA+PX | ✔ | ✔ |
| Project X Scheme | PXS | WA+PX | ✔ | ✔ |
| Replay | WAGAME | WA | ❌ | ❌ |
| Scheme | WSC | WA, WWP | ✔ | ✔ |
| Scheme Options | OPT | W2 | ✔ | ✔ |
| Scheme Weapons | WEP | W2 | ✔ | ✔ |
| Team Container | ST1 | W2 | ✔ | ✔ |
| Team Container | WGT | WA | ✔ | ✔ |
| Team Container | WWP | WWP | ✔ | ✔ |
## Available tools
## 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).
## Availability
The libraries are available on [NuGet](https://www.nuget.org/packages?q=Syroot.Worms).