Welcome to pyctr’s documentation!

PyCTR is a Python library to interact with Nintendo 3DS files.

It can read data from different kinds of files:

• CDN contents - pyctr.type.cdn

• Game card dumps (CTR Cart Image/CCI) - pyctr.type.cci

• CIA files (CTR Importable Archive) - pyctr.type.cia

• ExeFS containers - pyctr.type.exefs

• RomFS containers - pyctr.type.romfs

• NCCH containers - pyctr.type.ncch

• NAND backups - pyctr.type.nand

• SD card files inside “Nintendo 3DS” - pyctr.type.sd

• SD card titles - pyctr.type.sdtitle

• SMDH icons - pyctr.type.smdh

• Title Metadata files (TMD) - pyctr.type.tmd

It can emulate cryptography features of the 3DS:

• AES key engine and key scrambler - pyctr.crypto.engine

• Seed database (SeedDB) - pyctr.crypto.seeddb

Install

PyCTR requires Python 3.8 or later.

It can be installed with pip:

$ pip install pyctr

Getting started

• Example: Read contents from a CIA
• Example: Read and write NAND partitions

App containers

• pyctr.type.cdn module
• pyctr.type.cia module
• pyctr.type.cci module
• pyctr.type.ncch module
• pyctr.type.sdtitle module

App data

• exefs - ExeFS reader
• romfs - RomFS reader

App metadata

• pyctr.type.smdh module
• pyctr.type.tmd module

Console data

• nand - NAND images
• sdfs - SD card filesystem
• sd - SD card contents

Encryption

• engine - AES engine tools
• seeddb - SeedDB management

Extras

• util - Utility functions
• fileio - Special files

Indices and tables

• Index

• Module Index

• Search Page