NinjaCheetah/libWiiPy
1
0
Fork 0
mirror of https://github.com/NinjaCheetah/libWiiPy.git synced 2025-04-25 12:51:01 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for LZ77 module

Browse Source
This commit is contained in:
Campbell 2025-01-16 22:43:51 -05:00
parent f0b79e1f39
commit 93790d6f58
Signed by: NinjaCheetah
GPG Key ID: 670C282B3291D63D
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/archive/archive.md
View File

@ -3,10 +3,11 @@
## Modules
The `libWiiPy.archive` package contains modules for packing and extracting archive formats used by the Wii. This currently includes packing and unpacking support for U8 archives and decompression support for ASH archives.
| Module | Description |
|--------------------------------------|---------------------------------------------------------|
| [libWiiPy.archive.ash](/archive/ash) | Provides support for decompressing ASH archives |
| [libWiiPy.archive.u8](/archive/u8) | Provides support for packing and extracting U8 archives |
| Module | Description |
|----------------------------------------|---------------------------------------------------------|
| [libWiiPy.archive.ash](/archive/ash) | Provides support for decompressing ASH archives |
| [libWiiPy.archive.lz77](/archive/lz77) | Provides support for the LZ77 compression scheme |
| [libWiiPy.archive.u8](/archive/u8) | Provides support for packing and extracting U8 archives |
### libWiiPy.archive Package Contents
@ -14,5 +15,6 @@ The `libWiiPy.archive` package contains modules for packing and extracting archi
:maxdepth: 4
/archive/ash
/archive/lz77
/archive/u8
```

12
docs/source/archive/lz77.md Normal file
View File

@ -0,0 +1,12 @@
# libWiiPy.archive.lz77 Module
The `libWiiPy.archive.lz77` module provides support for handling LZ77 compression, which is a compression format used across the Wii and other Nintendo consoles.
## Module Contents
```{eval-rst}
.. automodule:: libWiiPy.archive.lz77
:members:
:undoc-members:
:show-inheritance:
```