fivefury 0.2.5__tar.gz → 0.2.7__tar.gz

fivefury-0.2.7/LICENSE

@@ -0,0 +1,111 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights upon the creator and subsequent owner(s)
+(each and all, an "owner") of an original work of authorship and/or a database
+(each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific works
+("Commons") that the public can reliably and without fear of later claims of
+infringement build upon, modify, incorporate in other works, reuse and
+redistribute as freely as possible in any form whatsoever and for any purposes,
+including without limitation commercial purposes. These owners may contribute to
+the Commons to promote the ideal of a free culture and the further production of
+creative, cultural and scientific works, or to gain reputation or greater
+distribution for their Work in part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation of
+additional consideration or compensation, the person associating CC0 with a Work
+(the "Affirmer"), to the extent that he or she is an owner of Copyright and
+Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
+publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and Related
+Rights"). Copyright and Related Rights include, but are not limited to, the
+following:
+
+i. the right to reproduce, adapt, distribute, perform, display, communicate, and
+translate a Work;
+
+ii. moral rights retained by the original author(s) and/or performer(s);
+
+iii. publicity and privacy rights pertaining to a person's image or likeness
+depicted in a Work;
+
+iv. rights protecting against unfair competition in regards to a Work, subject to
+the limitations in paragraph 4(a), below;
+
+v. rights protecting the extraction, dissemination, use and reuse of data in a
+Work;
+
+vi. database rights (such as those arising under Directive 96/9/EC of the
+European Parliament and of the Council of 11 March 1996 on the legal protection
+of databases, and under any national implementation thereof, including any
+amended or successor version of such directive); and
+
+vii. other similar, equivalent or corresponding rights throughout the world based
+on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and
+Related Rights and associated claims and causes of action, whether now known or
+unknown (including existing as well as future claims and causes of action), in
+the Work (i) in all territories worldwide, (ii) for the maximum duration provided
+by applicable law or treaty (including future time extensions), (iii) in any
+current or future medium and for any number of copies, and (iv) for any purpose
+whatsoever, including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to revocation,
+rescission, cancellation, termination, or any other legal or equitable action to
+disrupt the quiet enjoyment of the Work by the public as contemplated by
+Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver shall
+be preserved to the maximum extent permitted taking into account Affirmer's
+express Statement of Purpose. In addition, to the extent the Waiver is so judged
+Affirmer hereby grants to each affected person a royalty-free, non transferable,
+non sublicensable, non exclusive, irrevocable and unconditional license to
+exercise Affirmer's Copyright and Related Rights in the Work (i) in all
+territories worldwide, (ii) for the maximum duration provided by applicable law
+or treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was applied
+by Affirmer to the Work. Should any part of the License for any reason be judged
+legally invalid or ineffective under applicable law, such partial invalidity or
+ineffectiveness shall not invalidate the remainder of the License, and in such
+case Affirmer hereby affirms that he or she will not (i) exercise any of his or
+her remaining Copyright and Related Rights in the Work or (ii) assert any
+associated claims and causes of action with respect to the Work, in either case
+contrary to Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+a. No trademark or patent rights held by Affirmer are waived, abandoned,
+surrendered, licensed or otherwise affected by this document.
+
+b. Affirmer offers the Work as-is and makes no representations or warranties of
+any kind concerning the Work, express, implied, statutory or otherwise, including
+without limitation warranties of title, merchantability, fitness for a particular
+purpose, non infringement, or the absence of latent or other defects, accuracy,
+or the presence or absence of errors, whether or not discoverable, all to the
+greatest extent permissible under applicable law.
+
+c. Affirmer disclaims responsibility for clearing rights of other persons that
+may apply to the Work or any use thereof, including without limitation any
+person's Copyright and Related Rights in the Work. Further, Affirmer disclaims
+responsibility for obtaining any necessary consents, permissions or other rights
+required for any use of the Work.
+
+d. Affirmer understands and acknowledges that Creative Commons is not a party to
+this document and has no duty or obligation with respect to this CC0 or use of
+the Work.

{fivefury-0.2.5 → fivefury-0.2.7}/MANIFEST.in

@@ -1,2 +1,3 @@
-include native/*.h
+include LICENSE
+include native/*.h
 recursive-include fivefury/ydr *.xml

fivefury-0.2.7/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: fivefury
+Version: 0.2.7
+Summary: Python library for GTA V asset workflows including YMAP, YTYP, RPF, YTD and GameFileCache utilities.
+Author: Codex
+License-Expression: CC0-1.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: miniaudio>=1.71
+Dynamic: license-file
+
+# FiveFury
+
+FiveFury is a Python library for reading, writing, and packaging GTA V asset files: drawables, collisions, map metadata, animations, navigation data, texture dictionaries, text tables, audio containers, cutscenes, DLC metadata, and RPF archives.
+
+It targets practical modding workflows — declarative high-level helpers for common authoring tasks, with access to the underlying binary and resource layers when you need them. Heavy operations (vertex packing, collision generation, hashing, crypto, resource layout, archive scanning) run in a bundled native extension.
+
+## Installation
+
+```bash
+pip install fivefury
+```
+
+Python 3.11+ is required.
+
+The Assimp-backed import helpers (`assimp_to_ydr`, `obj_to_ydr`, `fbx_to_ydr`, `obj_to_nav`) additionally require the `impasse` package and a native `assimp` library reachable through the environment (usually via `PATH`).
+
+## Format support
+
+| Format | Status | Scope |
+| --- | --- | --- |
+| `YDR` | Full | Drawables: models, LODs, materials, shaders, lights, embedded textures and bounds, skeletons, skinning |
+| `CDR` | Read | PS3 drawables: materials, LODs, QB/EDGE geometry, compressed indices, skeletons and skinning |
+| `YDD` | Full | Drawable dictionaries, creation from named drawables, ped-component rigging helpers |
+| `YBN` | Full | Primitive, composite, geometry, and BVH bounds; collision generation from triangle meshes |
+| `YCD` | Full | Clip dictionaries: skeletal, object, UV, camera, and root-motion tracks |
+| `YMAP` | Full | Entities, car generators, occluders, timecycle modifiers, LOD/distant lights |
+| `YTYP` | Full | Base/time/MLO archetypes, extensions, rooms, portals, entity sets |
+| `YMF` | Full | Map manifests, IMAP/ITYP dependencies, generation from YMAP sets |
+| `YTD` | Full | Texture dictionaries: read/write, extraction, embedded-asset helpers |
+| `YND` | Full | Path nodes, links, area partitioning, junction heightmaps |
+| `YNV` | Full | Navmeshes: sectors, polys, portals, validation, basic OBJ partitioning |
+| `CUT` | Full | Cutscenes, plus the readable `.cuts` script format for round-trip authoring |
+| `GXT2` | Full | Hashed text tables with binary read/write and text import/export |
+| `AWC` | Full | Audio containers: PCM/WAV extraction, authoring from WAV/MP3/OGG/FLAC |
+| `RPF` | Full | RPF7 archives: nested archives, folder/ZIP conversion, encrypted archive reading |
+| DLC metadata | Full | `setup2.xml`, `content.xml`, `dlclist.xml`, title-update patch overlays |
+| `GTXD` | Full | Parent texture dictionary metadata (XML and binary RBF) |
+| `YFT` | Partial | Fragment read/write: drawables, physics LODs/groups/children, composite bounds |
+| `REL` | Partial | Audio metadata banks; typed models for synths, curves, categories, and common sound graphs |
+| `YED` | Partial | Expression dictionaries: inspection, spring editing, small dictionaries from scratch |
+| `YMT` | Partial | META/PSO/RBF read/write with typed helpers for known roots; unknown payloads preserved |
+| `YPT` | Partial | Embedded texture dictionary discovery/extraction only |
+| `YWR`, `YVR` | Indexed | Detected by `GameFileCache` and RPF tooling; no dedicated parser yet |
+| `YFD`, `YPDB`, `MRF` | — | Not implemented |
+
+`YDR` and `CDR` expose the same format-neutral drawable interface for LODs, models, meshes, materials, parameters, textures, and shader metadata. Their binary layouts remain isolated: PC/Enhanced authoring stays in `ydr`, while PS3 resource pages, QB/EDGE geometry, and console shader additions stay in `cdr`.
+
+## Quick start
+
+### Create a YMAP and pack it into an RPF
+
+```python
+from fivefury import Ymap, create_rpf
+
+ymap = Ymap(name="example_map")
+ymap.entity("prop_tree_pine_01", position=(100, 200, 0), lod_dist=150.0)
+ymap.car_gen("sultan", (110, 205, 0), heading=90)
+ymap.save("example_map.ymap", auto_extents=True)
+
+archive = create_rpf("mods.rpf")
+archive.add("stream/example_map.ymap", ymap)
+archive.save("mods.rpf")
+```
+
+### Build a drawable
+
+```python
+from fivefury import YdrMeshInput, create_ydr
+
+ydr = create_ydr(
+    meshes=[
+        YdrMeshInput(
+            positions=[(0.0, 0.0, 0.0), (1.0, 0.0, 0.0), (0.0, 1.0, 0.0)],
+            indices=[0, 1, 2],
+            texcoords=[[(0.0, 0.0), (1.0, 0.0), (0.0, 1.0)]],
+        )
+    ],
+    material_textures={"DiffuseSampler": "example_diffuse"},
+    name="example_drawable",
+)
+ydr.save("example_drawable.ydr")
+```
+
+Existing drawables can be read with `read_ydr(...)`, then edited through `update_material(...)`, `add_embedded_texture(...)`, `set_bound(...)`, skeleton and skinning helpers, and saved back. `assimp_to_ydr(...)` imports any mesh format Assimp can read.
+
+### Generate collision
+
+```python
+from fivefury import BoundMaterial, BoundMaterialType, build_bound_from_triangles, save_ybn
+
+triangles = [
+    ((0.0, 0.0, 0.0), (4.0, 0.0, 0.0), (0.0, 4.0, 0.0)),
+    ((4.0, 0.0, 0.0), (4.0, 4.0, 0.0), (0.0, 4.0, 0.0)),
+]
+
+bound = build_bound_from_triangles(
+    triangles,
+    material=BoundMaterial(type=BoundMaterialType.CONCRETE),
+)
+save_ybn(bound, "floor_collision.ybn")
+```
+
+Generated geometry is chunked as needed and gets BVH and octant data. The same bounds model backs standalone `YBN` files, embedded `YDR` collisions, and `YFT` physics — a drawable's render mesh can also be converted directly with `ydr.ensure_bound_from_render_geometry()`.
+
+### Convert audio to AWC
+
+```python
+from fivefury import convert_audio_to_awc
+
+convert_audio_to_awc("music/song.flac", "stream/song.awc", channels=2)
+```
+
+### Work with RPF archives
+
+```python
+from fivefury import RpfArchive, RpfExportMode, rpf_to_zip, zip_to_rpf
+
+zip_to_rpf("unpacked_mod_folder", "packed_mod.rpf")
+rpf_to_zip("packed_mod.rpf", "packed_mod.zip", mode=RpfExportMode.STANDALONE)
+
+with RpfArchive.from_path("packed_mod.rpf") as archive:
+    archive.to_folder("out", mode=RpfExportMode.STANDALONE)
+```
+
+Encrypted standalone archives open directly; FiveFury initializes the bundled crypto context automatically. Export modes: `STORED` (raw bytes), `STANDALONE` (valid standalone files with `RSC7` containers), `LOGICAL` (inner payloads).
+
+### Index a game installation
+
+```python
+from fivefury import GameFileCache
+
+cache = GameFileCache(r"C:\Program Files (x86)\Steam\steamapps\common\Grand Theft Auto V")
+cache.scan_game(use_index_cache=True)
+
+asset = cache.get_asset("prop_tree_pine_01", kind=".ydr")
+cache.extract_asset(asset, "prop_tree_pine_01.ydr")
+cache.extract_asset_textures("prop_tree_pine_01.ydr", "textures")
+```
+
+`GameFileCache` indexes loose files and archives, loads supported formats lazily, exposes typed lookups by name/hash/kind, resolves textures through `YTD`, `GTXD` parent chains, and embedded dictionaries, and can generate `YMF` manifests for custom maps. Scan scope is configurable (`dlc_level`, `exclude_folders`, `load_audio`, `load_vehicles`, `load_peds`).
+
+### Author DLC metadata
+
+```python
+from fivefury import write_dlc_folder_metadata
+
+write_dlc_folder_metadata("build/my_pack", pack_name="my_pack", order=60)
+```
+
+Scans the extracted DLC folder, infers common entries (nested `.rpf`, `.ityp` requests, audio data, text metadata), and writes `setup2.xml` and `content.xml`. `DlcPatch` builds `update.rpf` title-update overlays.
+
+## API conventions
+
+High-level objects follow a consistent shape: `add_*` for collections, `set_*` for single assignments, `build()` to normalize derived state, and `validate()` to collect consistency issues before writing. Formats with stable game-side names expose typed enums (shaders, LODs, render masks, archetype asset types, bound materials, track formats).
+
+## License
+
+FiveFury is released under the `CC0-1.0` public domain dedication. See [LICENSE](LICENSE).
+
+Release notes live in [CHANGELOG.md](CHANGELOG.md).

fivefury-0.2.7/README.md

@@ -0,0 +1,160 @@
+# FiveFury
+
+FiveFury is a Python library for reading, writing, and packaging GTA V asset files: drawables, collisions, map metadata, animations, navigation data, texture dictionaries, text tables, audio containers, cutscenes, DLC metadata, and RPF archives.
+
+It targets practical modding workflows — declarative high-level helpers for common authoring tasks, with access to the underlying binary and resource layers when you need them. Heavy operations (vertex packing, collision generation, hashing, crypto, resource layout, archive scanning) run in a bundled native extension.
+
+## Installation
+
+```bash
+pip install fivefury
+```
+
+Python 3.11+ is required.
+
+The Assimp-backed import helpers (`assimp_to_ydr`, `obj_to_ydr`, `fbx_to_ydr`, `obj_to_nav`) additionally require the `impasse` package and a native `assimp` library reachable through the environment (usually via `PATH`).
+
+## Format support
+
+| Format | Status | Scope |
+| --- | --- | --- |
+| `YDR` | Full | Drawables: models, LODs, materials, shaders, lights, embedded textures and bounds, skeletons, skinning |
+| `CDR` | Read | PS3 drawables: materials, LODs, QB/EDGE geometry, compressed indices, skeletons and skinning |
+| `YDD` | Full | Drawable dictionaries, creation from named drawables, ped-component rigging helpers |
+| `YBN` | Full | Primitive, composite, geometry, and BVH bounds; collision generation from triangle meshes |
+| `YCD` | Full | Clip dictionaries: skeletal, object, UV, camera, and root-motion tracks |
+| `YMAP` | Full | Entities, car generators, occluders, timecycle modifiers, LOD/distant lights |
+| `YTYP` | Full | Base/time/MLO archetypes, extensions, rooms, portals, entity sets |
+| `YMF` | Full | Map manifests, IMAP/ITYP dependencies, generation from YMAP sets |
+| `YTD` | Full | Texture dictionaries: read/write, extraction, embedded-asset helpers |
+| `YND` | Full | Path nodes, links, area partitioning, junction heightmaps |
+| `YNV` | Full | Navmeshes: sectors, polys, portals, validation, basic OBJ partitioning |
+| `CUT` | Full | Cutscenes, plus the readable `.cuts` script format for round-trip authoring |
+| `GXT2` | Full | Hashed text tables with binary read/write and text import/export |
+| `AWC` | Full | Audio containers: PCM/WAV extraction, authoring from WAV/MP3/OGG/FLAC |
+| `RPF` | Full | RPF7 archives: nested archives, folder/ZIP conversion, encrypted archive reading |
+| DLC metadata | Full | `setup2.xml`, `content.xml`, `dlclist.xml`, title-update patch overlays |
+| `GTXD` | Full | Parent texture dictionary metadata (XML and binary RBF) |
+| `YFT` | Partial | Fragment read/write: drawables, physics LODs/groups/children, composite bounds |
+| `REL` | Partial | Audio metadata banks; typed models for synths, curves, categories, and common sound graphs |
+| `YED` | Partial | Expression dictionaries: inspection, spring editing, small dictionaries from scratch |
+| `YMT` | Partial | META/PSO/RBF read/write with typed helpers for known roots; unknown payloads preserved |
+| `YPT` | Partial | Embedded texture dictionary discovery/extraction only |
+| `YWR`, `YVR` | Indexed | Detected by `GameFileCache` and RPF tooling; no dedicated parser yet |
+| `YFD`, `YPDB`, `MRF` | — | Not implemented |
+
+`YDR` and `CDR` expose the same format-neutral drawable interface for LODs, models, meshes, materials, parameters, textures, and shader metadata. Their binary layouts remain isolated: PC/Enhanced authoring stays in `ydr`, while PS3 resource pages, QB/EDGE geometry, and console shader additions stay in `cdr`.
+
+## Quick start
+
+### Create a YMAP and pack it into an RPF
+
+```python
+from fivefury import Ymap, create_rpf
+
+ymap = Ymap(name="example_map")
+ymap.entity("prop_tree_pine_01", position=(100, 200, 0), lod_dist=150.0)
+ymap.car_gen("sultan", (110, 205, 0), heading=90)
+ymap.save("example_map.ymap", auto_extents=True)
+
+archive = create_rpf("mods.rpf")
+archive.add("stream/example_map.ymap", ymap)
+archive.save("mods.rpf")
+```
+
+### Build a drawable
+
+```python
+from fivefury import YdrMeshInput, create_ydr
+
+ydr = create_ydr(
+    meshes=[
+        YdrMeshInput(
+            positions=[(0.0, 0.0, 0.0), (1.0, 0.0, 0.0), (0.0, 1.0, 0.0)],
+            indices=[0, 1, 2],
+            texcoords=[[(0.0, 0.0), (1.0, 0.0), (0.0, 1.0)]],
+        )
+    ],
+    material_textures={"DiffuseSampler": "example_diffuse"},
+    name="example_drawable",
+)
+ydr.save("example_drawable.ydr")
+```
+
+Existing drawables can be read with `read_ydr(...)`, then edited through `update_material(...)`, `add_embedded_texture(...)`, `set_bound(...)`, skeleton and skinning helpers, and saved back. `assimp_to_ydr(...)` imports any mesh format Assimp can read.
+
+### Generate collision
+
+```python
+from fivefury import BoundMaterial, BoundMaterialType, build_bound_from_triangles, save_ybn
+
+triangles = [
+    ((0.0, 0.0, 0.0), (4.0, 0.0, 0.0), (0.0, 4.0, 0.0)),
+    ((4.0, 0.0, 0.0), (4.0, 4.0, 0.0), (0.0, 4.0, 0.0)),
+]
+
+bound = build_bound_from_triangles(
+    triangles,
+    material=BoundMaterial(type=BoundMaterialType.CONCRETE),
+)
+save_ybn(bound, "floor_collision.ybn")
+```
+
+Generated geometry is chunked as needed and gets BVH and octant data. The same bounds model backs standalone `YBN` files, embedded `YDR` collisions, and `YFT` physics — a drawable's render mesh can also be converted directly with `ydr.ensure_bound_from_render_geometry()`.
+
+### Convert audio to AWC
+
+```python
+from fivefury import convert_audio_to_awc
+
+convert_audio_to_awc("music/song.flac", "stream/song.awc", channels=2)
+```
+
+### Work with RPF archives
+
+```python
+from fivefury import RpfArchive, RpfExportMode, rpf_to_zip, zip_to_rpf
+
+zip_to_rpf("unpacked_mod_folder", "packed_mod.rpf")
+rpf_to_zip("packed_mod.rpf", "packed_mod.zip", mode=RpfExportMode.STANDALONE)
+
+with RpfArchive.from_path("packed_mod.rpf") as archive:
+    archive.to_folder("out", mode=RpfExportMode.STANDALONE)
+```
+
+Encrypted standalone archives open directly; FiveFury initializes the bundled crypto context automatically. Export modes: `STORED` (raw bytes), `STANDALONE` (valid standalone files with `RSC7` containers), `LOGICAL` (inner payloads).
+
+### Index a game installation
+
+```python
+from fivefury import GameFileCache
+
+cache = GameFileCache(r"C:\Program Files (x86)\Steam\steamapps\common\Grand Theft Auto V")
+cache.scan_game(use_index_cache=True)
+
+asset = cache.get_asset("prop_tree_pine_01", kind=".ydr")
+cache.extract_asset(asset, "prop_tree_pine_01.ydr")
+cache.extract_asset_textures("prop_tree_pine_01.ydr", "textures")
+```
+
+`GameFileCache` indexes loose files and archives, loads supported formats lazily, exposes typed lookups by name/hash/kind, resolves textures through `YTD`, `GTXD` parent chains, and embedded dictionaries, and can generate `YMF` manifests for custom maps. Scan scope is configurable (`dlc_level`, `exclude_folders`, `load_audio`, `load_vehicles`, `load_peds`).
+
+### Author DLC metadata
+
+```python
+from fivefury import write_dlc_folder_metadata
+
+write_dlc_folder_metadata("build/my_pack", pack_name="my_pack", order=60)
+```
+
+Scans the extracted DLC folder, infers common entries (nested `.rpf`, `.ityp` requests, audio data, text metadata), and writes `setup2.xml` and `content.xml`. `DlcPatch` builds `update.rpf` title-update overlays.
+
+## API conventions
+
+High-level objects follow a consistent shape: `add_*` for collections, `set_*` for single assignments, `build()` to normalize derived state, and `validate()` to collect consistency issues before writing. Formats with stable game-side names expose typed enums (shaders, LODs, render masks, archetype asset types, bound materials, track formats).
+
+## License
+
+FiveFury is released under the `CC0-1.0` public domain dedication. See [LICENSE](LICENSE).
+
+Release notes live in [CHANGELOG.md](CHANGELOG.md).