Skip to main content

Python library for working with the Gecko Code format for Wii/GC

Project description

geckocode-libs

Python library for parsing and editing Gecko Codes for the Wii/GCN

Installation

pip install geckolibs

Usage

With geckocode-libs, file parsing is simple to do.

You can read a textual codelist into a GeckoCodeTable using the method GeckoCodeTable.from_text(our_text), which automatically detects the type of codelist being read and handles all the dirty work for you! This returns a new GeckoCodeTable object.

You can also read a raw codelist from a GCT using the method GeckoCodeTable.from_bytes(our_bytes), which parses the raw bytes given to the method into a new GeckoCodeTable object.

When you are done editing your GCT, you can convert the object back into a codelist, text, or raw data using the methods GeckoCodeTable.as_codelist(codelist_type), GeckoCodeTable.as_text(), and GeckoCodeTable.as_bytes() respectively.

You can also create your own codes using the library itself, an example shown here:

gct = GeckoCodeTable()                      # Empty GCT
code = GeckoCode("Our awesome code", "Me")  # Empty GeckoCode named "Our awesome code", created by "Me"
command = Write32(0x60000000, 0x80231480)   # Individual command

code.add_child(command)                     # Add a command to the code
gct.add_child(code)                         # Add a code to the GCT

Type checking of codes can be done in 3 ways:

code = Write8(69, 0x80203932)

code == Write8                              # True
code.codetype == Write8.codetype            # True
code.codetype == GeckoCommand.Type.WRITE_8  # True

It should be noted that in order to check multiple codetypes at once, code.codetype should be used.

Notes

Please give credit to this project when using it! :)

Project details


Download files

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

Source Distribution

geckolibs-0.0.3.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

geckolibs-0.0.3-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file geckolibs-0.0.3.tar.gz.

File metadata

  • Download URL: geckolibs-0.0.3.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for geckolibs-0.0.3.tar.gz
Algorithm Hash digest
SHA256 79ea686cf3982c385d13cc6e012fabbfcf89ee4a7a88c9118684bc49243d15e0
MD5 761866432ff92715cf4bb925e0c53873
BLAKE2b-256 f8f22664140549ed301023b3e8288ac4376b91f9884065a04686199a807f87e1

See more details on using hashes here.

File details

Details for the file geckolibs-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: geckolibs-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.0 setuptools/51.1.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.5

File hashes

Hashes for geckolibs-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c790b517d44872cefabcdc551909245bbe9243587dee9e92d0d96695634a2c46
MD5 d227dc824e68dce4be877252ca2a1427
BLAKE2b-256 d9732e7a94076b6c0eff877cd130171df36b062ae55ac68a50086fc1d5e87c8e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page