{"id":28416962,"url":"https://github.com/opencpn/opencpn-libs","last_synced_at":"2025-09-09T04:36:20.082Z","repository":{"id":197930557,"uuid":"699787873","full_name":"OpenCPN/opencpn-libs","owner":"OpenCPN","description":"Common libraries submodule, primarily for use in plugins","archived":false,"fork":false,"pushed_at":"2025-09-01T14:41:18.000Z","size":110116,"stargazers_count":2,"open_issues_count":3,"forks_count":7,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-01T16:36:57.954Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenCPN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-10-03T10:45:04.000Z","updated_at":"2025-09-01T14:41:21.000Z","dependencies_parsed_at":"2024-10-20T02:06:47.024Z","dependency_job_id":"6a7634a7-6ac2-4557-ab23-852bc21c005b","html_url":"https://github.com/OpenCPN/opencpn-libs","commit_stats":null,"previous_names":["opencpn/opencpn-libs"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/OpenCPN/opencpn-libs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCPN%2Fopencpn-libs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCPN%2Fopencpn-libs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCPN%2Fopencpn-libs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCPN%2Fopencpn-libs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenCPN","download_url":"https://codeload.github.com/OpenCPN/opencpn-libs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenCPN%2Fopencpn-libs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274244015,"owners_count":25248156,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"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":"2025-06-04T01:43:38.499Z","updated_at":"2025-09-09T04:36:20.075Z","avatar_url":"https://github.com/OpenCPN.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"opencpn-libs README\n===================\n\nThis is a set of libraries used by OpenCPN plugins, managed as a git submodule.\nIt provides a standardized way to share common functionality across plugins\nwhile maintaining version control and consistency.\n\nOverview\n--------\n\nThe repository contains several types of libraries:\n\n1. API Libraries (api-16, api-17, api-18):\n   - Core interfaces for plugin-OpenCPN communication\n   - Different versions support various OpenCPN releases\n   - Plugins should use the latest API version compatible with their minimum supported OpenCPN version\n2. Utility Libraries:\n   - Data Processing: jsoncpp, json-schema-validator, pugixml, tinyxml\n   - Compression: bzip2, lz4, zlib\n   - Navigation: nmea0183, n2kparser\n   - Graphics: wxsvg, opencpn-glu\n   - Network: curl, wxcurl\n   - And more specialized libraries for specific functionality\n\nAdding the submodule\n--------------------\n\n    $ git submodule add https://github.com/OpenCPN/opencpn-libs.git\n    $ git commit -m \"Adding opencpn-libs submodule\"\n\nUpdating to latest status\n-------------------------\n\n    $ git submodule update --remote --merge opencpn-libs\n    $ git add opencpn-libs\n    $ git commit -m \"Updating opencpn-libs to latest version.\"\n\nUsing it\n--------\n\nAll libraries exports a link target named like ocpn::lz4. To find the exact\nname, check the file CMakeLists.txt which is available in the top directory\nof each library. Look for a line like `add_library(ocpn::lz4 ALIAS _LZ4)`.\n\nA library is typically used like\n\n    add_subdirectory(\"${CMAKE_SOURCE_DIR}/opencpn-libs/lz4\")\n    target_link_libraries(${PACKAGE_NAME} ocpn::lz4)\n\nNote:  the name _target_link_libraries_ is somewhat misleading. It is not\njust about linkage, running it means importing all sorts of include paths,\ncompile constants and libraries required when using the library.\n\nRemoving the submodule\n----------------------\n\nNormally not required, but if:\n\n    $ git submodule deinit -f opencpn-libs\n    $ git rm --cached opencpn-libs\n    $ rm -rf .git/modules/opencpn-libs\n    $ rm -rf opencpn-libs\n    $ git config -f .gitmodules --remove-section submodule.opencpn-libs\n    $ git add .gitmodules\n    $ git commit -m \"Remove opencpn-libs submodule.\"\n\nMore: https://stackoverflow.com/questions/1260748\n\nUpdating libraries\n------------------\n\nLibraries in opencpn-libs can if necessary be updated locally. The basic\nflow is\n\n    - `cd opencpn-libs/some-lib`\n    - Edit some-file\n    - `git commit -am \"Why I changed this file\"`\n    - `cd ../..`\n    - `git add opencpn-libs`\n    - `git commit -m \"Adding local change to opencpn-libs\"`\n\nThe commit will be part of the submodule, not the main repo. If the need of\nsuch a change is deemed necessary, please make a PR against\nhttps://github.com/OpenCPN/opencpn-libs/ so it can be integrated in the main\nset of plugins.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencpn%2Fopencpn-libs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencpn%2Fopencpn-libs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencpn%2Fopencpn-libs/lists"}