freadblangks / pycasclib

Python object-oriented bindings for Ladislav Zezula's CASCLib (https://github.com/ladislav-zezula/CascLib)

pyCASCLib

Python object-oriented bindings for Ladislav Zezula's CASCLib (https://github.com/ladislav-zezula/CascLib)

pyCASCLib is a minimalistic Cython based wrapper for CASCLib. Currently not all the lib features are suported, but support for additional functions will be added in the future. Contributions are welcome.

Building

Cython is required to build this project as a Python module.

After installing Cython run python3 setup.py build_ext --inplace to build the Python module. Once the building is finished, the library is ready to use in Python.

The build script should build CascLib automatically and link against it. Build parameteres are set in setup.py script file. On Linux/Mac you may be required to have BZip2 installed into your system.

Example usage

The Python API of the library is documented in the code with docstrings and type hints.

from CASC import CASCHandler, FileOpenFlags, LocaleFlags

# As a context manager
with CASCHandler('/Volumes/something/World of Warcraft/', LocaleFlags.CASC_LOCALE_ENUS, False) as casc:
    flags = FileOpenFlags.CASC_OPEN_BY_FILEID  # load file by FileDataID

    with casc.read_file(189077, flags) as file:  # CASCFile can also be opened as a context manager
        print(file.data) # get raw file bytes, lazy loading is supported
        print(file.info.file_data_id)  # get file's info, lazy loading is supported
        
    print(casc.file_exists(189077, flags))  # check if file exists
    
# Usage with manual closing
casc = CASCHandler('/Volumes/something/World of Warcraft/', LocaleFlags.CASC_LOCALE_ENUS, False)
print(('world/arttest/boxtest/xyz.m2', FileOpenFlags.CASC_OPEN_BY_NAME) in casc)  # check if file exists
casc.close()