GitLab/Worms2server
1
0
Fork 0
mirror of https://gitlab.com/Syroot/Worms.git synced 2025-05-05 11:19:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://gitlab.com/Syroot/Worms

Browse Source
This commit is contained in:
Ray Koopa 2020-07-02 05:29:15 +02:00
commit 4454cb1496
1 changed files with 29 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -1,44 +1,38 @@
# 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).
## Supported file formats | 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` | ✔ | ✔ |
| Description | Extension | Games | Load | Save | Implementation of formats listed above as unsupported is planned for a later date.
|-------------------|:---------:|:-----------:|:----:|:----:|
| 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 ## 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.
* `Syroot.Worms.Mgame.GameServer`: Simulates a server communicating with OW or WWPA clients (WIP). * `Syroot.Worms.Mgame.GameServer`: Simulates a server communicating with OW or WWPA clients (WIP).
## Support ## Availability
The libraries are available as separate [NuGet packages](https://www.nuget.org/packages?q=Syroot.Worms).
The libraries are available on [NuGet](https://www.nuget.org/packages?q=Syroot.Worms).