https://github.com/retreev/PangLib
Series of tools to interact with Pangya PC MMO game files
https://github.com/retreev/PangLib
csharp-library pangya preservation
Last synced: 16 days ago
JSON representation
Series of tools to interact with Pangya PC MMO game files
- Host: GitHub
- URL: https://github.com/retreev/PangLib
- Owner: retreev
- License: agpl-3.0
- Created: 2018-10-13T01:17:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T00:46:52.000Z (about 1 year ago)
- Last Synced: 2025-04-24T13:40:52.477Z (about 1 month ago)
- Topics: csharp-library, pangya, preservation
- Language: C#
- Homepage:
- Size: 301 KB
- Stars: 17
- Watchers: 3
- Forks: 14
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PangLib
[](https://www.codacy.com/gh/pangyatools/PangLib/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pangyatools/PangLib&utm_campaign=Badge_Grade) [](https://discord.gg/HwDTssf)
Series of tools to interact with Pangya (PC) 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](https://www.microsoft.com/net/download) on your system.
All libraries are published on Nuget with their respective full package name, so you can install using the .NET CLI:
```shell
$ dotnet add package [package-name]
```
## Available Libraries
| Library | Version | Build Status | Description |
|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [**PangLib.IFF**](PangLib.IFF/) | [](https://www.nuget.org/packages/PangLib.IFF/) | [](https://github.com/retreev/PangLib/actions/workflows/iff-build.yaml) | Library to handle and parse data from `.iff` files |
| [**PangLib.DAT**](PangLib.DAT/) | [](https://www.nuget.org/packages/PangLib.DAT/) | [](https://github.com/retreev/PangLib/actions/workflows/dat-build.yaml) | Library to handle and parse data from `.dat` files |
| [**PangLib.PAK**](PangLib.PAK/) | [](https://www.nuget.org/packages/PangLib.PAK/) | [](https://github.com/retreev/PangLib/actions/workflows/pak-build.yaml) | Library to handle and parse data from `.pak` files |
| [**PangLib.PET**](PangLib.PET/) | [](https://www.nuget.org/packages/PangLib.PET/) | [](https://github.com/retreev/PangLib/actions/workflows/pet-build.yaml) | Library to handle and parse data from `.*pet` files |
| [**PangLib.SBIN**](PangLib.SBIN/) | [](https://www.nuget.org/packages/PangLib.SBIN/) | [](https://github.com/retreev/PangLib/actions/workflows/sbin-build.yaml) | Library to handle and parse data from `.sbin` files |
| [**PangLib.Scripting**](PangLib.Scripting/) | [](https://www.nuget.org/packages/PangLib.Scripting/) | [](https://github.com/retreev/PangLib/actions/workflows/scripting-build.yaml) | Library to handle and parse Pangya scripting languages |
| [**PangLib.UCC**](PangLib.UCC/) | [](https://www.nuget.org/packages/PangLib.UCC/) | [](https://github.com/retreev/PangLib/actions/workflows/ucc-build.yaml) | Library to handle and parse data from SelfDesign files |
| [**PangLib.UpdateList**](PangLib.UpdateList/) | [](https://www.nuget.org/packages/PangLib.UpdateList/) | [](https://github.com/retreev/PangLib/actions/workflows/updatelist-build.yaml) | Library to handle and parse data from `updatelist` files |
| [**PangLib.Utilities**](PangLib.Utilities/) | [](https://www.nuget.org/packages/PangLib.Utilities/) | [](https://github.com/retreev/PangLib/actions/workflows/utilities-build.yaml) | Common utilities used in other `PangLib` libraries |
| [**PangLib.WEP**](PangLib.WEP/) | [](https://www.nuget.org/packages/PangLib.WEP/) | [](https://github.com/retreev/PangLib/actions/workflows/wep-build.yaml) | Library to handle and parse data from `.(g/sg/ai)bin` files |
## Building
To build PangLib or any of the libraries inside it, you need, just as for using it, the [.NET Core SDK](https://www.microsoft.com/net/download).
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.PET/`) 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](https://pangya.community/t/panglib-a-toolchain-for-pangya-files/22)
- [RageZone](http://forum.ragezone.com/f513/panglib-set-libraries-pangya-game-1162203/)
## Documentation
Documentation on the parsed file formats can be found at [docs.pangya.golf](https://docs.pangya.golf)
## Acknowledgements
PangLib would not be possible with prior research and tooling developed by others, namely:
* [HSReina](https://github.com/HSReina) for several tools and hints, especially around PET models
* [jchv](https://github.com/jchv) for [the Blender import script](https://github.com/retreev/io_scene_mpet)
* [Dave Devils](https://github.com/DaveDevils) for the documentation provided in [PangTools](https://github.com/davedevils/PangTools)
* [Acrisio Filho](https://github.com/Acrisio-Filho) for [the provided GBIN and SBIN readers](https://github.com/Acrisio-Filho/SuperSS-Dev/tree/master/Tools)
## License
This project is licensed under the AGPL-3.0