Skip to main content

No project description provided

Project description

z3r-sramr

Installation

pip install z3r-sramr-py

Functions

parse_sram(sram, validate_sram=true)

Accepts a bytes object and optional boolean argument. If you want to skip the SRAM validation checks, you can pass False as the second argument. Returns a dict with three sub dicts: 'meta', 'stats', and 'equipment'. See keys.txt for a list of all keys.

Can raise a ParseException if one of the validation checks fail or another error occurs.

validate_sram(sram)

Accepts a bytes object. Returns True if the object is valid ALTTPR SRAM and False if one of the checks fail. The parse_sram() function calls this function by default.

Example

from z3rsramr import parse_sram

with open("example.srm", "rb") as f:
    sram = f.read()

sram_map = parse_sram(sram)

print(f'Current Rupees: {sram_map['equipment']['current rupees']}')
print(f'Collection Rate: {sram_map['stats']['collection rate']}')
print(f'Menu Time: {sram_map['stats']['menu time']}')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distributions

z3r_sramr_py-0.2.4-cp38-none-win_amd64.whl (112.4 kB view hashes)

Uploaded cp38

z3r_sramr_py-0.2.4-cp37-none-win_amd64.whl (112.4 kB view hashes)

Uploaded cp37

z3r_sramr_py-0.2.4-cp36-none-win_amd64.whl (112.6 kB view hashes)

Uploaded cp36

z3r_sramr_py-0.2.4-cp35-none-win_amd64.whl (112.6 kB view hashes)

Uploaded cp35

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page