{"id":22420549,"url":"https://github.com/a-sync/screen-avg-color","last_synced_at":"2025-03-27T04:43:01.979Z","repository":{"id":86400909,"uuid":"146220429","full_name":"a-sync/screen-avg-color","owner":"a-sync","description":"Get the true average RGB color of your screen, or part of your screen.","archived":false,"fork":false,"pushed_at":"2018-09-02T11:48:52.000Z","size":7,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-17T08:47:27.723Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a-sync.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-08-26T22:16:01.000Z","updated_at":"2023-11-14T10:07:36.000Z","dependencies_parsed_at":"2023-09-29T06:48:25.764Z","dependency_job_id":null,"html_url":"https://github.com/a-sync/screen-avg-color","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"f7deb3178508d8a4454234a033d712cbcfb1ecaf"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-sync%2Fscreen-avg-color","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-sync%2Fscreen-avg-color/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-sync%2Fscreen-avg-color/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-sync%2Fscreen-avg-color/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-sync","download_url":"https://codeload.github.com/a-sync/screen-avg-color/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245785717,"owners_count":20671631,"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-12-05T16:20:14.447Z","updated_at":"2025-03-27T04:43:01.956Z","avatar_url":"https://github.com/a-sync.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# screen-avg-color [![npm (scoped)](https://img.shields.io/npm/v/screen-avg-color.svg)](https://www.npmjs.com/package/screen-avg-color) \nNative nodejs module to return the average RGB color of your screen, or part of your screen.\n\n# Supported OS\n - [x] Windows\n - [ ] Linux\n - [ ] OSX\n\n## Install\n```sh\nnpm install screen-avg-color\n```\n\n## Example\n```javascript\nconst getColor = require('screen-avg-color');\n\ngetColor((err, r, g, b) =\u003e {\n    if (err) console.error(err);\n\n    console.log('R:' + r, 'G:' + g, 'B:' + b);\n});\n```\n\n## API\n```javascript\nrequire('screen-avg-color')(callback, options);\n```\n\n### callback(err, red, green, blue)\n - err: string with error message *(null if there was no error)*\n - red: integer 0-255\n - green: integer 0-255\n - blue: integer 0-255\n\n### options {x=0, y=0, width=0, height=0, scale=10}\n#### x, y\nThe x and y coordinates for the top left corner of the screen.\n\n#### width, height\nThe width and height of the screen in pixels. *(set to 0 to use the actual screen width or height)*\n\n#### scale\nThe target size of the grabbed bitmap in percent. *(1-100)*  \n(A bigger bitmap might return more precise values but it can significantly slow down the response time.)\n\n---\n\n## TODO\n - support for linux and osx\n - option to select which screen to use in a multi display setup\n - rewrite native bindings to n-api\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-sync%2Fscreen-avg-color","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-sync%2Fscreen-avg-color","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-sync%2Fscreen-avg-color/lists"}