{"id":13528950,"url":"https://github.com/AlubJ/Airkiver","last_synced_at":"2025-04-01T14:33:44.464Z","repository":{"id":173812140,"uuid":"651332517","full_name":"AlubJ/Airkiver","owner":"AlubJ","description":"Game File Archive Tool","archived":false,"fork":false,"pushed_at":"2023-11-18T03:19:09.000Z","size":985,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-02T15:36:30.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Yacc","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlubJ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-06-09T02:43:26.000Z","updated_at":"2023-06-09T02:43:31.000Z","dependencies_parsed_at":"2023-11-18T03:51:56.171Z","dependency_job_id":null,"html_url":"https://github.com/AlubJ/Airkiver","commit_stats":null,"previous_names":["alubj/airkiver"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlubJ%2FAirkiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlubJ%2FAirkiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlubJ%2FAirkiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlubJ%2FAirkiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlubJ","download_url":"https://codeload.github.com/AlubJ/Airkiver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246655480,"owners_count":20812642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T07:00:29.536Z","updated_at":"2025-04-01T14:33:41.514Z","avatar_url":"https://github.com/AlubJ.png","language":"Yacc","funding_links":[],"categories":["Data Manipulation"],"sub_categories":["Recommendations"],"readme":"# Airkiver\nGame File Archive Tool\n\n## Tested Platforms\nI have tested this on Windows, MacOS, and iOS. It has worked quite well on those three platforms.\n\n## Performance Overhead\nWith smaller archives, the performance is quite good, with the `.retrieve()` method only taking about 0.06ms to execute, but with bigger archives, this number can ramp up. I tested this with an 800MB archive (2.5GB uncompressed) and the `.retrieve()` method took ~300ms to execute. I highly doubt that most GameMaker projects are going to use 2.5GB of external data.\n\n## Airkive.py usage:\n`python Airkive.py [outputName]`\n\nThe Python script will ignore certain files, you can edit these in the script. The default files to get ignored are;\n - `\".DS_Store\"`\n - `\"Airkiver.py\"`\n - `\"[outputName].ft\"`\n - `\"[outputName].fs\"`\n\n## GML usage:\n### Load File Table\n`new Airkiver([filepath], [build_directory_tree])` Load an Airkive file and return an Airkive Struct\n\nReturns: `Struct`\n\n| Argument | Type | Default | Description |\n|---|---|---|---|\n|`filepath`|`String`|`\"\"`|Filepath of the archive filetable|\n|`build_directory_tree`|`Bool`|`true`|Whether to build a directory tree on load|\n\n### Load Method\n`.load([filepath])` Load an Airkive file into the struct\n\nReturns: N/A\n\n| Argument | Type | Default | Description |\n|---|---|---|---|\n|`filepath`|`String`|N/A|Filepath of the archive filetable|\n\n### Build Directory Tree Method\n`.build_directory_tree()` Build a directory tree based on the file table\n\nReturns: N/A\n\n### Retrieve Method\n`.retrieve(filepath, [validate])` Retrieve an archived file\n\nReturns: `Buffer ID`\n\n| Argument | Type | Default | Description |\n|---|---|---|---|\n|`filepath`|`String`|N/A|Filepath of the archived file|\n|`validate`|`Bool`|`false`|Validate file with CRC32|\n\n### Retrieve Text Method\n`.retrieve_text(filepath, [validate])` Retrieve an archived file as a string\n\nReturns: `String`\n\n| Argument | Type | Default | Description |\n|---|---|---|---|\n|`filepath`|`String`|N/A|Filepath of the archived file|\n|`validate`|`Bool`|`false`|Validate file with CRC32|\n\n### Exists Method\n`.exists(filepath)` Check if a file exists in the archive\n\nReturns: `Bool`\n\n| Argument | Type | Default | Description |\n|---|---|---|---|\n|`filepath`|`String`|N/A|Filepath of the archived file|\n\n### Retrieve Names Method\n`.retrieve_names()` Retrieve the list of filenames as an array\n\nReturns: `Array\u003cString\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlubJ%2FAirkiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlubJ%2FAirkiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlubJ%2FAirkiver/lists"}