From 13dee4ecbf917527f0c8956b7406406bbc10a5cb Mon Sep 17 00:00:00 2001 From: Ray Koopa Date: Sat, 12 Jan 2019 22:25:12 +0100 Subject: [PATCH] Update readme. --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 39c116c..20f995d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Worms -This .NET library can access and modify file formats of the following second generation Worms games developed by Team17: +The following .NET libraries in this repository can access and modify file formats of second generation Worms games +developed by Team17: -* W2: Worms2 -* WA: Worms Armageddon -* WWP: Worms World Party -* OW: Online Worms (Asia licensed client) -* PX: ProjectX (Worms Armageddon extension) +* 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 @@ -18,6 +20,8 @@ This .NET library can access and modify file formats of the following second gen | 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 | @@ -33,10 +37,10 @@ This .NET library can access and modify file formats of the following second gen ## Available tools -* Online Worms Launcher: Creates a fake launch configuration to start the game with. -* Online Worms Server: Simulates a server communicating with Online Worms clients (WIP). +* Mgame Launcher: Creates a fake launch configuration to start OW or WWPA clients with. +* Mgame Server: Simulates a server communicating with OW or WWPA clients (WIP). ## Support -The library is available as a [NuGet package](https://www.nuget.org/packages/Syroot.Worms). +The libraries are available as a [NuGet package](https://www.nuget.org/profiles/Syroot). You can ask questions and suggest features on Discord aswell. Feel free to [join the Worms channel on the Syroot server](https://discord.gg/r6dz7yh)!