{"id":20767772,"url":"https://github.com/dmnsgn/geom-export-obj","last_synced_at":"2026-03-03T02:33:55.624Z","repository":{"id":57249896,"uuid":"355671582","full_name":"dmnsgn/geom-export-obj","owner":"dmnsgn","description":"Convert one (or more) simplicial complex geometry (positions/cells/normals/uvs/vertexColors) into an OBJ string.","archived":false,"fork":false,"pushed_at":"2025-03-13T15:20:49.000Z","size":2553,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-09T06:56:00.803Z","etag":null,"topics":["exporter","geometry","obj","simplicial-complex","wavefront","wavefront-obj"],"latest_commit_sha":null,"homepage":"https://dmnsgn.github.io/geom-export-obj/","language":"JavaScript","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/dmnsgn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-07T20:17:43.000Z","updated_at":"2025-03-13T15:20:53.000Z","dependencies_parsed_at":"2024-11-17T23:49:41.003Z","dependency_job_id":null,"html_url":"https://github.com/dmnsgn/geom-export-obj","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"1173cfbdf0bf070896113f94e530c7954293e6a3"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/dmnsgn/geom-export-obj","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fgeom-export-obj","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fgeom-export-obj/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fgeom-export-obj/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fgeom-export-obj/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmnsgn","download_url":"https://codeload.github.com/dmnsgn/geom-export-obj/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmnsgn%2Fgeom-export-obj/sbom","scorecard":{"id":348181,"data":{"date":"2025-08-11","repo":{"name":"github.com/dmnsgn/geom-export-obj","commit":"8bed242ae5a0ca0b4314f3e9f8d2cb06f4ea86d7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/20 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}}]},"last_synced_at":"2025-08-18T07:40:14.824Z","repository_id":57249896,"created_at":"2025-08-18T07:40:14.824Z","updated_at":"2025-08-18T07:40:14.824Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30030829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T00:31:48.536Z","status":"online","status_checked_at":"2026-03-03T02:00:07.650Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["exporter","geometry","obj","simplicial-complex","wavefront","wavefront-obj"],"created_at":"2024-11-17T11:33:20.921Z","updated_at":"2026-03-03T02:33:55.595Z","avatar_url":"https://github.com/dmnsgn.png","language":"JavaScript","funding_links":["https://paypal.me/dmnsgn"],"categories":[],"sub_categories":[],"readme":"# geom-export-obj\n\n[![npm version](https://img.shields.io/npm/v/geom-export-obj)](https://www.npmjs.com/package/geom-export-obj)\n[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://www.npmjs.com/package/geom-export-obj)\n[![npm minzipped size](https://img.shields.io/bundlephobia/minzip/geom-export-obj)](https://bundlephobia.com/package/geom-export-obj)\n[![dependencies](https://img.shields.io/librariesio/release/npm/geom-export-obj)](https://github.com/dmnsgn/geom-export-obj/blob/main/package.json)\n[![types](https://img.shields.io/npm/types/geom-export-obj)](https://github.com/microsoft/TypeScript)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fa6673.svg)](https://conventionalcommits.org)\n[![styled with prettier](https://img.shields.io/badge/styled_with-Prettier-f8bc45.svg?logo=prettier)](https://github.com/prettier/prettier)\n[![linted with eslint](https://img.shields.io/badge/linted_with-ES_Lint-4B32C3.svg?logo=eslint)](https://github.com/eslint/eslint)\n[![license](https://img.shields.io/github/license/dmnsgn/geom-export-obj)](https://github.com/dmnsgn/geom-export-obj/blob/main/LICENSE.md)\n\nConvert one (or more) simplicial complex geometry (positions/cells/normals/uvs) into an OBJ string.\n\n[![paypal](https://img.shields.io/badge/donate-paypal-informational?logo=paypal)](https://paypal.me/dmnsgn)\n[![coinbase](https://img.shields.io/badge/donate-coinbase-informational?logo=coinbase)](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)\n[![twitter](https://img.shields.io/twitter/follow/dmnsgn?style=social)](https://twitter.com/dmnsgn)\n\n![](https://raw.githubusercontent.com/dmnsgn/geom-export-obj/main/screenshot.png)\n\n## Installation\n\n```bash\nnpm install geom-export-obj\n```\n\n## Usage\n\n```js\nimport geomExportObj from \"geom-export-obj\";\nimport { cube } from \"primitive-geometry\";\nconsole.log(geomExportObj(cube()).output);\n```\n\n## API\n\n\u003c!-- api-start --\u003e\n\n## Modules\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#module_geomExportObj\"\u003egeomExportObj\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003c/dl\u003e\n\n## Typedefs\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#SimplicialComplex\"\u003eSimplicialComplex\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eGeometry definition. All optional.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#GeomExportObjOffsets\"\u003eGeomExportObjOffsets\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eOffsets to for cells. Useful if appending to another obj string. Used internally.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#GeomExportObjOptions\"\u003eGeomExportObjOptions\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eOptions for exporter.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#GeomExportObjReturnValue\"\u003eGeomExportObjReturnValue\u003c/a\u003e : \u003ccode\u003eobject\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"module_geomExportObj\"\u003e\u003c/a\u003e\n\n## geomExportObj\n\n- [geomExportObj](#module_geomExportObj)\n  - [geomExportObj(geometries, [options])](#exp_module_geomExportObj--geomExportObj) ⇒ [\u003ccode\u003eGeomExportObjReturnValue\u003c/code\u003e](#GeomExportObjReturnValue) ⏏\n    - [.parse(geometry, [offsets], [defaultName])](#module_geomExportObj--geomExportObj.parse) ⇒ \u003ccode\u003estring\u003c/code\u003e\n\n\u003ca name=\"exp_module_geomExportObj--geomExportObj\"\u003e\u003c/a\u003e\n\n### geomExportObj(geometries, [options]) ⇒ [\u003ccode\u003eGeomExportObjReturnValue\u003c/code\u003e](#GeomExportObjReturnValue) ⏏\n\nParse one or more simplicial complex geometry and return an obj string and vertices offsets.\n\n**Kind**: Exported function\n\n| Param      | Type                                                                                                                       | Default         |\n| ---------- | -------------------------------------------------------------------------------------------------------------------------- | --------------- |\n| geometries | [\u003ccode\u003eSimplicialComplex\u003c/code\u003e](#SimplicialComplex) \\| [\u003ccode\u003eArray.\u0026lt;SimplicialComplex\u0026gt;\u003c/code\u003e](#SimplicialComplex) |                 |\n| [options]  | [\u003ccode\u003eGeomExportObjOptions\u003c/code\u003e](#GeomExportObjOptions)                                                                 | \u003ccode\u003e{}\u003c/code\u003e |\n\n\u003ca name=\"module_geomExportObj--geomExportObj.parse\"\u003e\u003c/a\u003e\n\n#### geomExportObj.parse(geometry, [offsets], [defaultName]) ⇒ \u003ccode\u003estring\u003c/code\u003e\n\nParse a simplicial complex and return an obj string\n\n**Kind**: static method of [\u003ccode\u003egeomExportObj\u003c/code\u003e](#exp_module_geomExportObj--geomExportObj)\n**See**: http://paulbourke.net/dataformats/obj/\n\n| Param         | Type                                                       | Default                                            | Description                                              |\n| ------------- | ---------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------------- |\n| geometry      | [\u003ccode\u003eSimplicialComplex\u003c/code\u003e](#SimplicialComplex)       |                                                    |                                                          |\n| [offsets]     | [\u003ccode\u003eGeomExportObjOffsets\u003c/code\u003e](#GeomExportObjOffsets) | \u003ccode\u003e{ positions: 0, normals: 0, uvs: 0 }}\u003c/code\u003e |                                                          |\n| [defaultName] | \u003ccode\u003estring\u003c/code\u003e                                        |                                                    | A name for the object if geometry.name is not specified. |\n\n\u003ca name=\"SimplicialComplex\"\u003e\u003c/a\u003e\n\n## SimplicialComplex : \u003ccode\u003eobject\u003c/code\u003e\n\nGeometry definition. All optional.\n\n**Kind**: global typedef\n**Properties**\n\n| Name           | Type                              | Description               |\n| -------------- | --------------------------------- | ------------------------- |\n| positions      | \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e |                           |\n| normals        | \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e |                           |\n| uvs            | \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e |                           |\n| cells          | \u003ccode\u003eArray.\u0026lt;number\u0026gt;\u003c/code\u003e |                           |\n| name           | \u003ccode\u003estring\u003c/code\u003e               | The object name.          |\n| [materialName] | \u003ccode\u003estring\u003c/code\u003e               | The object material name. |\n\n\u003ca name=\"GeomExportObjOffsets\"\u003e\u003c/a\u003e\n\n## GeomExportObjOffsets : \u003ccode\u003eobject\u003c/code\u003e\n\nOffsets to for cells. Useful if appending to another obj string. Used internally.\n\n**Kind**: global typedef\n**Properties**\n\n| Name      | Type                |\n| --------- | ------------------- |\n| positions | \u003ccode\u003enumber\u003c/code\u003e |\n| normals   | \u003ccode\u003enumber\u003c/code\u003e |\n| uvs       | \u003ccode\u003enumber\u003c/code\u003e |\n\n\u003ca name=\"GeomExportObjOptions\"\u003e\u003c/a\u003e\n\n## GeomExportObjOptions : \u003ccode\u003eobject\u003c/code\u003e\n\nOptions for exporter.\n\n**Kind**: global typedef\n**Properties**\n\n| Name      | Type                                                       | Default                                           | Description                         |\n| --------- | ---------------------------------------------------------- | ------------------------------------------------- | ----------------------------------- |\n| [header]  | \u003ccode\u003estring\u003c/code\u003e                                        | \u003ccode\u003e\u0026quot;# geom-export-obj\\\\n\u0026quot;\u003c/code\u003e     | Header to be prepended to the file. |\n| [prefix]  | \u003ccode\u003estring\u003c/code\u003e                                        | \u003ccode\u003e\u0026quot;Mesh\\_\u0026quot;\u003c/code\u003e                   | Prefix for object names.            |\n| [offsets] | [\u003ccode\u003eGeomExportObjOffsets\u003c/code\u003e](#GeomExportObjOffsets) | \u003ccode\u003e{ positions: 0, normals: 0, uvs: 0 }\u003c/code\u003e | The initial offsets for cells.      |\n\n\u003ca name=\"GeomExportObjReturnValue\"\u003e\u003c/a\u003e\n\n## GeomExportObjReturnValue : \u003ccode\u003eobject\u003c/code\u003e\n\n**Kind**: global typedef\n**Properties**\n\n| Name    | Type                                                       | Description          |\n| ------- | ---------------------------------------------------------- | -------------------- |\n| output  | \u003ccode\u003estring\u003c/code\u003e                                        | The obj as a string. |\n| offsets | [\u003ccode\u003eGeomExportObjOffsets\u003c/code\u003e](#GeomExportObjOffsets) |                      |\n\n\u003c!-- api-end --\u003e\n\n## License\n\nMIT. See [license file](https://github.com/dmnsgn/geom-export-obj/blob/main/LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fgeom-export-obj","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmnsgn%2Fgeom-export-obj","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmnsgn%2Fgeom-export-obj/lists"}