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

(docs) Began writing module descriptions

Browse Source
This commit is contained in:
Campbell 2024-12-21 18:09:37 -05:00
parent c2f6225500
commit e45c7a3076
Signed by: NinjaCheetah
GPG Key ID: 670C282B3291D63D
5 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/api.md
View File

@ -9,10 +9,12 @@ libWiiPy is divided up into a few subpackages to organize related features.
| [libWiiPy.nand](/nand/nand) | Used for working with EmuNANDs and core system files on the Wii | | [libWiiPy.nand](/nand/nand) | Used for working with EmuNANDs and core system files on the Wii |
| [libWiiPy.title](/title/title) | Used for parsing and manipulating Wii titles | | [libWiiPy.title](/title/title) | Used for parsing and manipulating Wii titles |
When using libWiiPy in your project, you can choose to either only import the package that you need, or you can use `import libWiiPy` to import the entire package, which each module being available at `libWiiPy.<package>.<module>`.
## Full Package Contents ## Full Package Contents
```{toctree} ```{toctree}
:maxdepth: 4 :maxdepth: 8
/archive/archive /archive/archive
/media/media /media/media

4
docs/source/archive/ash.md
View File

@ -1,5 +1,9 @@
# libWiiPy.archive.ash Module # libWiiPy.archive.ash Module
The `libWiiPy.archive.ash` module provides support for handling ASH files, which are a compressed format primarily used in the Wii Menu, but also in some other titles such as My Pokémon Ranch.
At present, libWiiPy only has support for decompressing ASH files, with compression as a planned feature for the future.
## Module Contents ## Module Contents
```{eval-rst} ```{eval-rst}

4
docs/source/archive/u8.md
View File

@ -1,5 +1,9 @@
# libWiiPy.archive.u8 Module # libWiiPy.archive.u8 Module
The `libWiiPy.archive.u8` module provides support for handling U8 archives, which are a non-compressed archive format used extensively on the Wii to join multiple files into one.
This module exposes functions for both packing and unpacking U8 archives, as well as code to parse IMET headers. IMET headers are a header format used specifically for U8 archives containing the banner of a channel, as they store the localized name of the channel along with other banner metadata.
## Module Contents ## Module Contents
```{eval-rst} ```{eval-rst}

2
docs/source/media/banner.md
View File

@ -1,5 +1,7 @@
# libWiiPy.media.banner Module # libWiiPy.media.banner Module
The `libWiiPy.media.banner` module is essentially a stub at this point in time. It only provides one dataclass that is likely to become a traditional class when fully implemented. It is not recommended to use this module for anything yet.
## Module Contents ## Module Contents
```{eval-rst} ```{eval-rst}

2
docs/source/nand/emunand.md
View File

@ -1,5 +1,7 @@
# libWiiPy.nand.emunand Module # libWiiPy.nand.emunand Module
The `libWiiPy.nand.emunand` module provides support for creating and managing Wii EmuNANDs. At present, you cannot create an EmuNAND compatible with something like NEEK on a real Wii with the features provided by this library, but you can create an EmuNAND compatible with Dolphin.
## Module Contents ## Module Contents
```{eval-rst} ```{eval-rst}