NinjaCheetah/libWiiPy
1
0
Fork 0
mirror of https://github.com/NinjaCheetah/libWiiPy.git synced 2025-04-29 06:21:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Campbell 2024-05-07 21:35:22 -04:00 committed by GitHub
parent 045613216a
commit c42dc66209
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,7 +10,7 @@ libWiiPy is inspired by [libWiiSharp](https://github.com/TheShadowEevee/libWiiSh
This list will expand as libWiiPy is developed, but these features are currently available: This list will expand as libWiiPy is developed, but these features are currently available:
- TMD, ticket, and WAD parsing - TMD, ticket, and WAD parsing
- WAD content extraction, decryption, re-encryption, and packing - WAD content extraction, decryption, re-encryption, and packing
- Downloading free titles from the NUS - Downloading titles from the NUS
# Usage # Usage
A wiki, and in the future a potential documenation site, is being worked on, and can be accessed [here](https://github.com/NinjaCheetah/libWiiPy/wiki). It is currently fairly barebones, but it will be improved in the future. A wiki, and in the future a potential documenation site, is being worked on, and can be accessed [here](https://github.com/NinjaCheetah/libWiiPy/wiki). It is currently fairly barebones, but it will be improved in the future.
@ -31,27 +31,27 @@ Please be aware that because libWiiPy is in a very early state right now, many f
To build this package locally, the steps are quite simple, and should apply to all platforms. Make sure you've set up your `venv` first! To build this package locally, the steps are quite simple, and should apply to all platforms. Make sure you've set up your `venv` first!
First, install the dependencies from `requirements.txt`: First, install the dependencies from `requirements.txt`:
```py ```sh
pip install -r requirements.txt pip install -r requirements.txt
``` ```
Then, build the package using the Python `build` module: Then, build the package using the Python `build` module:
```py ```sh
python -m build python -m build
``` ```
And that's all! You'll find your compiled pip package in `dist/`. And that's all! You'll find your compiled pip package in `dist/`.
# Special Thanks # Special Thanks
This project wouldn't be possible without the amazing people behind its predecessors and all of the people who have contributed to the documentation of the Wii's inner workings over at [Wiibrew](https://wiibrew.org). This project wouldn't be possible without the amazing people behind its predecessors and all of the people who have contributed to the documentation of the Wii's inner workings over at [WiiBrew](https://wiibrew.org).
## Special Thanks for the Inspiration and Previous Projects ## Special Thanks for the Inspiration and Previous Projects
- Xuzz, SquidMan, megazig, Matt_P, Omega and The Lemon Man for creating Wii.py - Xuzz, SquidMan, megazig, Matt_P, Omega and The Lemon Man for creating Wii.py
- Leathl for creating libWiiSharp - Leathl for creating libWiiSharp
- TheShadowEevee for maintaining libWiiSharp - TheShadowEevee for maintaining libWiiSharp
## Special Thanks to Wiibrew Contributors ## Special Thanks to WiiBrew Contributors
Thank you to all of the contributors to the documentation on the Wiibrew pages that make this all understandable! Some of the key articles referenced are as follows: Thank you to all of the contributors to the documentation on the WiiBrew pages that make this all understandable! Some of the key articles referenced are as follows:
- [Title metadata](https://wiibrew.org/wiki/Title_metadata), for the documentation on how a TMD is structured - [Title metadata](https://wiibrew.org/wiki/Title_metadata), for the documentation on how a TMD is structured
- [WAD files](https://wiibrew.org/wiki/WAD_files), for the documentation on how a WAD is structured - [WAD files](https://wiibrew.org/wiki/WAD_files), for the documentation on how a WAD is structured
- [IOS history](https://wiibrew.org/wiki/IOS_history), for the documentation on IOS TIDs and how IOS is versioned - [IOS history](https://wiibrew.org/wiki/IOS_history), for the documentation on IOS TIDs and how IOS is versioned