API Documentation

libWiiPy is divided up into a few subpackages to organize related features.

Package	Description
libWiiPy.archive	Used to pack and extract archive formats used on the Wii
libWiiPy.media	Used for parsing and manipulating media formats used on the Wii
libWiiPy.nand	Used for working with EmuNANDs and core system files on the Wii
libWiiPy.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

• libWiiPy.archive Package
  • Modules
    • libWiiPy.archive Package Contents
      • libWiiPy.archive.ash Module
        • Module Contents
          • decompress_ash()
      • libWiiPy.archive.lz77 Module
        • Module Contents
          • decompress_lz77()
      • libWiiPy.archive.u8 Module
        • Module Contents
          • IMETHeader
            • IMETHeader.magic
            • IMETHeader.header_size
            • IMETHeader.imet_version
            • IMETHeader.sizes
            • IMETHeader.flag1
            • IMETHeader.channel_names
            • IMETHeader.md5_hash
            • IMETHeader.LocalizedTitles
              • IMETHeader.LocalizedTitles.TITLE_CHINESE_SIMPLIFIED
              • IMETHeader.LocalizedTitles.TITLE_CHINESE_TRADITIONAL
              • IMETHeader.LocalizedTitles.TITLE_DUTCH
              • IMETHeader.LocalizedTitles.TITLE_ENGLISH
              • IMETHeader.LocalizedTitles.TITLE_FRENCH
              • IMETHeader.LocalizedTitles.TITLE_GERMAN
              • IMETHeader.LocalizedTitles.TITLE_ITALIAN
              • IMETHeader.LocalizedTitles.TITLE_JAPANESE
              • IMETHeader.LocalizedTitles.TITLE_KOREAN
              • IMETHeader.LocalizedTitles.TITLE_SPANISH
            • IMETHeader.create()
            • IMETHeader.dump()
            • IMETHeader.get_channel_names()
            • IMETHeader.load()
            • IMETHeader.set_channel_names()
          • U8Archive
            • U8Archive.u8_node_list
            • U8Archive.file_name_list
            • U8Archive.file_data_list
            • U8Archive.header_size
            • U8Archive.data_offset
            • U8Archive.imet_header
            • U8Archive.dump()
            • U8Archive.load()
          • extract_u8()
          • pack_u8()
• libWiiPy.media Package
  • Modules
    • libWiiPy.media Package Contents
      • libWiiPy.media.banner Module
        • Module Contents
          • IMD5Header
            • IMD5Header.magic
            • IMD5Header.file_size
            • IMD5Header.zeros
            • IMD5Header.md5_hash
            • IMD5Header.file_size
            • IMD5Header.magic
            • IMD5Header.md5_hash
            • IMD5Header.zeros
• libWiiPy.nand Package
  • Modules
    • libWiiPy.nand Package Contents
      • libWiiPy.nand.emunand Module
        • Module Contents
          • EmuNAND
            • EmuNAND.emunand_root
            • EmuNAND.InstalledTitles
              • EmuNAND.InstalledTitles.type
              • EmuNAND.InstalledTitles.titles
              • EmuNAND.InstalledTitles.titles
              • EmuNAND.InstalledTitles.type
            • EmuNAND.get_installed_titles()
            • EmuNAND.get_title_ticket()
            • EmuNAND.get_title_tmd()
            • EmuNAND.install_title()
            • EmuNAND.uninstall_title()
      • libWiiPy.nand.setting Module
        • Module Contents
          • SettingTxt
            • SettingTxt.area
            • SettingTxt.model
            • SettingTxt.dvd
            • SettingTxt.mpch
            • SettingTxt.code
            • SettingTxt.serial_number
            • SettingTxt.video
            • SettingTxt.game
            • SettingTxt.dump()
            • SettingTxt.dump_decrypted()
            • SettingTxt.load()
            • SettingTxt.load_decrypted()
      • libWiiPy.nand.sys Module
        • Module Contents
          • UidSys
            • UidSys.uid_entries
            • UidSys.add()
            • UidSys.create()
            • UidSys.dump()
            • UidSys.load()
• libWiiPy.title Package
  • Modules
    • libWiiPy.title Package Contents
      • libWiiPy.title.cert Module
        • Module Contents
          • Certificate
            • Certificate.type
            • Certificate.signature
            • Certificate.issuer
            • Certificate.pub_key_type
            • Certificate.child_name
            • Certificate.pub_key_id
            • Certificate.pub_key_modulus
            • Certificate.pub_key_exponent
            • Certificate.dump()
            • Certificate.load()
          • CertificateChain
            • CertificateChain.ca_cert
            • CertificateChain.tmd_cert
            • CertificateChain.ticket_cert
            • CertificateChain.dump()
            • CertificateChain.load()
          • CertificateKeyLength
            • CertificateKeyLength.ECC
            • CertificateKeyLength.RSA_2048
            • CertificateKeyLength.RSA_4096
          • CertificateKeyType
            • CertificateKeyType.ECC
            • CertificateKeyType.RSA_2048
            • CertificateKeyType.RSA_4096
          • CertificateSignatureLength
            • CertificateSignatureLength.ECC
            • CertificateSignatureLength.RSA_2048
            • CertificateSignatureLength.RSA_4096
          • CertificateType
            • CertificateType.ECC
            • CertificateType.RSA_2048
            • CertificateType.RSA_4096
          • verify_ca_cert()
          • verify_cert_sig()
          • verify_ticket_sig()
          • verify_tmd_sig()
      • libWiiPy.title.commonkeys Module
        • Module Contents
          • get_common_key()
      • libWiiPy.title.content Module
        • Module Contents
          • ContentRegion
            • ContentRegion.content_records
            • ContentRegion.num_contents
            • ContentRegion.add_content()
            • ContentRegion.add_enc_content()
            • ContentRegion.dump()
            • ContentRegion.get_content_by_cid()
            • ContentRegion.get_content_by_index()
            • ContentRegion.get_contents()
            • ContentRegion.get_enc_content_by_cid()
            • ContentRegion.get_enc_content_by_index()
            • ContentRegion.get_enc_contents()
            • ContentRegion.get_index_from_cid()
            • ContentRegion.load()
            • ContentRegion.load_content()
            • ContentRegion.load_enc_content()
            • ContentRegion.remove_content_by_cid()
            • ContentRegion.remove_content_by_index()
            • ContentRegion.set_content()
            • ContentRegion.set_enc_content()
          • ContentType
            • ContentType.DLC
            • ContentType.HASH_TREE
            • ContentType.NORMAL
            • ContentType.SHARED
          • SharedContentMap
            • SharedContentMap.shared_records
            • SharedContentMap.add_content()
            • SharedContentMap.dump()
            • SharedContentMap.load()
      • libWiiPy.title.crypto Module
        • Module Contents
          • decrypt_content()
          • decrypt_title_key()
          • encrypt_content()
          • encrypt_title_key()
      • libWiiPy.title.iospatcher Module
        • Module Contents
          • IOSPatcher
            • IOSPatcher.title
            • IOSPatcher.es_module_index
            • IOSPatcher.dip_module_index
            • IOSPatcher.dump()
            • IOSPatcher.load()
            • IOSPatcher.patch_all()
            • IOSPatcher.patch_drive_inquiry()
            • IOSPatcher.patch_es_identify()
            • IOSPatcher.patch_fakesigning()
            • IOSPatcher.patch_nand_access()
            • IOSPatcher.patch_version_downgrading()
      • libWiiPy.title.nus Module
        • Module Contents
          • download_cert_chain()
          • download_content()
          • download_contents()
          • download_ticket()
          • download_title()
          • download_tmd()
      • libWiiPy.title.ticket Module
        • Module Contents
          • Ticket
            • Ticket.is_dev
            • Ticket.signature
            • Ticket.ticket_version
            • Ticket.title_key_enc
            • Ticket.ticket_id
            • Ticket.console_id
            • Ticket.title_version
            • Ticket.common_key_index
            • Ticket.dump()
            • Ticket.fakesign()
            • Ticket.get_common_key_type()
            • Ticket.get_is_fakesigned()
            • Ticket.get_title_id()
            • Ticket.get_title_key()
            • Ticket.load()
            • Ticket.set_title_id()
            • Ticket.set_title_version()
      • libWiiPy.title.title Module
        • Module Contents
          • Title
            • Title.wad
            • Title.cert_chain
            • Title.tmd
            • Title.ticket
            • Title.content
            • Title.add_content()
            • Title.add_enc_content()
            • Title.dump_wad()
            • Title.fakesign()
            • Title.get_content_by_cid()
            • Title.get_content_by_index()
            • Title.get_is_fakesigned()
            • Title.get_is_signed()
            • Title.get_title_size()
            • Title.get_title_size_blocks()
            • Title.load_cert_chain()
            • Title.load_content()
            • Title.load_content_records()
            • Title.load_ticket()
            • Title.load_tmd()
            • Title.load_wad()
            • Title.set_content()
            • Title.set_enc_content()
            • Title.set_title_id()
            • Title.set_title_version()
      • libWiiPy.title.tmd Module
        • Module Contents
          • TMD
            • TMD.title_id
            • TMD.title_version
            • TMD.tmd_version
            • TMD.ios_tid
            • TMD.ios_version
            • TMD.num_contents
            • TMD.AccessFlags
              • TMD.AccessFlags.AHB
              • TMD.AccessFlags.DVD_VIDEO
            • TMD.dump()
            • TMD.fakesign()
            • TMD.get_access_right()
            • TMD.get_content_record()
            • TMD.get_content_size()
            • TMD.get_content_size_blocks()
            • TMD.get_content_type()
            • TMD.get_is_fakesigned()
            • TMD.get_title_region()
            • TMD.get_title_type()
            • TMD.load()
            • TMD.set_title_id()
            • TMD.set_title_version()
      • libWiiPy.title.util Module
        • Module Contents
          • title_ver_dec_to_standard()
          • title_ver_standard_to_dec()
      • libWiiPy.title.wad Module
        • Module Contents
          • WAD
            • WAD.wad_type
            • WAD.wad_cert_size
            • WAD.wad_crl_size
            • WAD.wad_tik_size
            • WAD.wad_tmd_size
            • WAD.wad_content_size
            • WAD.wad_meta_size
            • WAD.dump()
            • WAD.get_cert_data()
            • WAD.get_content_data()
            • WAD.get_crl_data()
            • WAD.get_meta_data()
            • WAD.get_ticket_data()
            • WAD.get_tmd_data()
            • WAD.get_wad_type()
            • WAD.load()
            • WAD.set_cert_data()
            • WAD.set_content_data()
            • WAD.set_crl_data()
            • WAD.set_meta_data()
            • WAD.set_ticket_data()
            • WAD.set_tmd_data()