{"id":13718633,"url":"https://github.com/realityforge/zifnab","last_synced_at":"2026-01-14T02:10:33.590Z","repository":{"id":57740001,"uuid":"200830082","full_name":"realityforge/zifnab","owner":"realityforge","description":"Endless Sky Content Editing Tools","archived":true,"fork":false,"pushed_at":"2020-01-29T12:01:30.000Z","size":443,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-22T22:29:14.286Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/realityforge.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-06T10:31:07.000Z","updated_at":"2023-01-28T15:57:38.000Z","dependencies_parsed_at":"2022-08-30T10:51:19.468Z","dependency_job_id":null,"html_url":"https://github.com/realityforge/zifnab","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/realityforge/zifnab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realityforge%2Fzifnab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realityforge%2Fzifnab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realityforge%2Fzifnab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realityforge%2Fzifnab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/realityforge","download_url":"https://codeload.github.com/realityforge/zifnab/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/realityforge%2Fzifnab/sbom","scorecard":{"id":766617,"data":{"date":"2025-08-11","repo":{"name":"github.com/realityforge/zifnab","commit":"1a7a2fd3910635f60d99a94861f17a19fbb1c0d5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/30 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":"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":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"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":"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":"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":"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":"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":"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":"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"}},{"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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"}}]},"last_synced_at":"2025-08-23T01:01:41.337Z","repository_id":57740001,"created_at":"2025-08-23T01:01:41.337Z","updated_at":"2025-08-23T01:01:41.337Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"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":[],"created_at":"2024-08-03T01:00:34.869Z","updated_at":"2026-01-14T02:10:33.572Z","avatar_url":"https://github.com/realityforge.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zifnab: Endless Sky Content Editing Tools\n\n[\u003cimg src=\"https://img.shields.io/maven-central/v/org.realityforge.zifnab/zifnab-core.svg?label=latest%20release\"/\u003e](https://search.maven.org/search?q=g:org.realityforge.zifnab%20a:zifnab-core)\n\n## What is zifnab?\n\nZifnab is a simple library for manipulating and generating content for the [Endless Sky](http://endless-sky.github.io/) game.\n\n### Getting Started\n\nThe library is released to Maven Central and can be downloaded using normal dependency download mechanisms.\nThe Maven dependencies are:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.realityforge.zifnab\u003c/groupId\u003e\n  \u003cartifactId\u003ezifnab-hdf\u003c/artifactId\u003e\n  \u003cversion\u003e0.05\u003c/version\u003e\n\u003c/dependency\u003e\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.realityforge.zifnab\u003c/groupId\u003e\n  \u003cartifactId\u003ezifnab-core\u003c/artifactId\u003e\n  \u003cversion\u003e0.05\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nSee the `examples/` directory for a few examples of the tools in use.\n\n### Data File Format\n\nThe `zifnab.hdf` package contains tools for reading and writing the data file format used by `Endless Sky`. The\npackage is included in the `zifnab-hdf` artifact.\n\n#### Reading\n\nReading the file format is as simple as:\n\n```java\nfinal Path file = ...;\nfinal DataFile dataFile = DataFile.read( file );\n```\n\nThe `DataFile` object has a reference to the in memory representation of the data format and it is reasonably\neasy to traverse to extract information from the the file. i.e.\n\n```java\nfinal long topLevelElements = dataFile.getDocument().getChildElements().size();\nSystem.out.println( topLevelElements + \" top-level elements found in file.\" );\n```\n\n#### Writing\n\nThe current API for generating data in the correct format is low-level. A high-level API is expected to be available\nin the future. The low-level API for constructing the data file looks like:\n\n```java\nfinal DataDocument document = new DataDocument();\ndocument.comment( \"The humanitarian mission!\" );\nfinal DataElement element1 = document.element( \"mission\", \"Drought Relief\" );\nelement1.comment( \"The name of the mission as presented to user\" );\nelement1.element( \"name\", \"Drought relief to \u003cplanet\u003e\" );\nfinal DataElement offer = element1.element( \"to\", \"offer\" );\noffer.element( \"random\", \"\u003c\", \"10\" );\n\nfinal DataFile dataFile = new DataFile( Paths.get( \"output.txt\" ), document );\ndataFile.write();\n```\n\nAnd this would produce a file named `output.txt` that contains\n\n```\n# The humanitarian mission!\nmission \"Drought Relief\"\n\t# The name of the mission as presented to user\n\tname \"Drought relief to \u003cplanet\u003e\"\n\tto offer\n\t\trandom \u003c 10\n```\n\n# Contributing\n\nThe project was released as open source so others could benefit from the project. We are thankful for any\ncontributions from the community. A [Code of Conduct](CODE_OF_CONDUCT.md) has been put in place and\na [Contributing](CONTRIBUTING.md) document is under development.\n\n# License\n\nThe project is licensed under [Apache License, Version 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealityforge%2Fzifnab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frealityforge%2Fzifnab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealityforge%2Fzifnab/lists"}