retreev / panglib.wii

Series of tools to interact with 'Pangya: Super Swing Golf' Wii game files

PangLib.Wii

Series of tools to interact with 'Pangya: Super Swing Golf' (Wii) game files

Usage

The libraries are built using .NET Core and .NET Standard 2.0. So you need to download and setup the .NET Core SDK on your system.

All libraries are published on Nuget with their respective full package name, so you can install using the .NET CLI:

$ dotnet add package [package-name]

Available Libraries

Library	Version	Build Status	Description
PangLib.Wii.ECB			Library to handle and parse data from Wii .ECB files

Building

To build PangLib or any of the libraries inside it, you need, just as for using it, the .NET Core SDK.

Once the SDK is available on your system to use, you can either run the following commands in the project root to build every library from the solution, or navigate to a subfolder (e.g. PangLib.Wii.ECB/) and execute them there:

$ dotnet restore
$ dotnet build

If the commands run successfully, you now have compiled libraries available at [library-name]/bin/Debug/netstandard2.0/[arch]

To quickly test changes or use your local copy of a PangLib library in a project, you can run the following command to add a reference:

$ dotnet add reference [path to .csproj file of desired library]

This will now allow you to change the code of the library, and of your program and once you build your program, it will also build the referenced library again, so you don't have to manually include a built library or publish it to Nuget yourself.

Contributing

Want to contribute? Awesome!

You can contribute in many ways, like:

• Opening an issue if a problem with a library occurs.
• Opening an issue for a feature request, when a library is missing something you need.
• Opening an issue for a library request, if you need handling for another format.

Of course you can already contribute code if you are a developer, adding features, additional libraries and more, I'm pretty open to anything, as long as it is related to Pangya and the addition is reasonable!

Discuss on other Websites

Forum posts allowing for engagement and feedback on PangLib:

• pangya.community
• RageZone

Documentation

Documentation on the parsed file formats can be found at docs.pangya.golf

License

This project is licensed under the AGPL-3.0