{"id":13798471,"url":"https://github.com/sidneys/desktop-dimmer","last_synced_at":"2025-04-05T09:08:38.010Z","repository":{"id":13693998,"uuid":"74857371","full_name":"sidneys/desktop-dimmer","owner":"sidneys","description":"Enable darker-than-dark dimming for internal and external screens.","archived":false,"fork":false,"pushed_at":"2023-01-11T22:45:16.000Z","size":6310,"stargazers_count":365,"open_issues_count":50,"forks_count":38,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-04-14T12:29:34.980Z","etag":null,"topics":["dark","desktop","dimmer","dimming","electron","linux","macos","nodejs","shade","windows"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sidneys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-27T00:00:21.000Z","updated_at":"2024-04-01T07:53:40.000Z","dependencies_parsed_at":"2023-01-13T17:35:10.165Z","dependency_job_id":null,"html_url":"https://github.com/sidneys/desktop-dimmer","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fdesktop-dimmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fdesktop-dimmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fdesktop-dimmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidneys%2Fdesktop-dimmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sidneys","download_url":"https://codeload.github.com/sidneys/desktop-dimmer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312081,"owners_count":20918344,"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":["dark","desktop","dimmer","dimming","electron","linux","macos","nodejs","shade","windows"],"created_at":"2024-08-04T00:00:44.486Z","updated_at":"2025-04-05T09:08:37.964Z","avatar_url":"https://github.com/sidneys.png","language":"JavaScript","readme":"# Desktop Dimmer [![Beta](https://img.shields.io/badge/status-alpha-blue.svg?style=flat)]() [![travis](https://img.shields.io/travis/sidneys/desktop-dimmer.svg?style=flat)](https://travis-ci.org/sidneys/desktop-dimmer) [![appveyor](https://ci.appveyor.com/api/projects/status/oc57pq7hfslqg3ru?svg=true)](https://ci.appveyor.com/project/sidneys/desktop-dimmer) [![npm](https://img.shields.io/npm/v/desktop-dimmer.svg?style=flat)](https://npmjs.com/package/desktop-dimmer) [![dependencies](https://img.shields.io/david/sidneys/desktop-dimmer.svg?style=flat-square)](https://npmjs.com/package/desktop-dimmer) [![devDependencies](https://img.shields.io/david/dev/sidneys/desktop-dimmer.svg?style=flat-square)](https://npmjs.com/package/desktop-dimmer)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg height=\"250px\" src=\"https://raw.githubusercontent.com/sidneys/desktop-dimmer/master/resources/graphics/icon.png\"/\u003e\u003cbr\u003e\u003cbr\u003e\n  \u003cb\u003eEnable darker-than-dark dimming for internal and external screens.\u003c/b\u003e\u003cbr\u003e\n  Available for macOS, Windows and Linux (Beta).\n\u003c/p\u003e\n\n\n------\n\n![macOS](https://raw.githubusercontent.com/sidneys/desktop-dimmer/master/resources/screenshots/screenshot-macos.png)\n![Windows 10](https://raw.githubusercontent.com/sidneys/desktop-dimmer/master/resources/screenshots/screenshot-win32.png)\n\n------\n\n\u003e **Cross-Platform**\n\nTested on macOS Sierra, Windows 10 Anniversary. Beta support for Ubuntu 16.10. \n\n\u003e **Lean**\n\nSmall resource footprint, minimal User Interface.\n\n\u003e  **Unobstrusive**\n\nSettings are persisted and restored per-Display without any configuration.\n\n\u003e **Smart**\n\nHeading out? Disconnecting and reconnecting external displays are handled seamlessly.\n\n\u003e  **Open Source**\n\nGitHub-based workflow, MIT licensed.\n\n\n## Contents\n\n1. [Installation](#installation)\n2. [Developers](#development)\n3. [Continuous Integration](#continuous-integration)\n4. [Up Next](#up-next)\n5. [Contact](#contact)\n6. [Author](#author)\n\n\n## \u003ca name=\"installation\"/\u003e\u003c/a\u003e Installation\n\n### Standard Installation\n\nDownload the latest version of Desktop Dimmer on the [Releases](https://github.com/sidneys/desktop-dimmer/releases) page.\n\n### Installation as Commandline Tool\n\n```bash\nnpm install --global desktop-dimmer\t\t# Installs the node CLI module\ndesktop-dimmer\t\t\t\t\t\t\t# Runs it\n```\n\n\n## \u003ca name=\"developers\"/\u003e\u003c/a\u003e Developers\n\n### Sources\n\nClone the repo and install dependencies.\n\n```shell\ngit clone https://github.com/sidneys/desktop-dimmer.git desktop-dimmer\ncd desktop-dimmer\nnpm install\n```\n\n### Scripts\n\n#### npm run **start**\n\nRun the app with integrated Electron.\n\n```bash\nnpm run start\nnpm run start:dev \t\t\t\t\t# with Debugging Tools\nnpm run start:livereload \t\t\t# with Debugging Tools and Livereload\n```\n\n#### npm run **localsetup**\n\nInstall the app in the System app folder and start it.\n\n```bash\nnpm run localsetup\nnpm run localsetup:rebuild\t\t\t# Build before installation\nnpm run localsetup:rebuild:dev \t\t# Build before installation, use Developer Tools\n```\n\n#### npm run **build**\n\nBuild the app and create installers (see [requirements](#build-requirements)).\n\n```bash\nnpm run build\t\t\t\t\t# build all available platforms\nnpm run build macos windows\t\t# build specific platforms (macos/linux/windows)\n```\n\n### Build Requirements\n\n* Building for Windows requires [`wine`](https://winehq.org) and [`mono`](https://nsis.sourceforge.net/Docs/Chapter3.htm) (on macOS, Linux)\n* Building for Linux requires  [`fakeroot`](https://wiki.debian.org/FakeRoot) and [`dpkg `](https://wiki.ubuntuusers.de/dpkg/) (on macOS, Windows)\n* Only macOS can build for other platforms.\n\n#### macOS Build Setup\n\nInstall [Homebrew](https://brew.sh), then run:\n\n```bash\nbrew install wine mono fakeroot dpkg\n```\n\n#### Linux  Build Setup\n\n```bash\nsudo apt-get install wine mono fakeroot dpkg\n```\n\n\n## \u003ca name=\"continuous-integration\"/\u003e\u003c/a\u003e Continuous Integration\n\n\u003e Turnkey **build-in-the-cloud** for Windows 10, macOS and Linux.\n\nThe process is managed by a custom layer of node scripts and Electron-optimized configuration templates.\nCompleted Installation packages are deployed to [GitHub Releases](https://github.com/sidneys/desktop-dimmer/releases). Builds for all platforms and architectures take about 5 minutes.\nBacked by the open-source-friendly guys at [Travis](https://travis-ci.org/) and [AppVeyor](https://ci.appveyor.com/) and running [electron-packager](https://github.com/electron-userland/electron-packager) under the hood.\n\n### Setup\n\n1.  [Fork](https://github.com/sidneys/desktop-dimmer/fork) the repo\n2.  Generate your GitHub [Personal Access Token](https://github.com/settings/tokens) using \"repo\" as scope. Copy it to the clipboard.\n3.  **macOS + Linux**\n     1. Sign in to [Travis](https://travis-ci.org/) using GitHub.\n     2. Open your [Travis Profile](https://travis-ci.org/profile), click \"Sync Account\" and wait for the process to complete.\n     3. Find this repository in the list, enable it and click \"⚙\" to open its settings.\n     4. Create a new Environment Variable named **GITHUB_TOKEN**. Paste your Token from step 2 as *value*. \n4.  **Windows**\n     1. Sign in to [AppVeyor](https://ci.appveyor.com/) using GitHub.\n     2. Click on [\"New Project\"](https://ci.appveyor.com/projects/new), select \"GitHub\", look up this repo in the list and click \"Add\".\n     3. After import navigate to the *Settings* \u003e *Environment* subsection\n     4. Select \"Add Variable\", insert **GITHUB_TOKEN** for *name*, paste your Token as *value*. Save.\n\n### Triggering Builds\n\n1. Add a new Tag to start the build process:\n\n   ```shell\n   git tag -a v1.0.1\n   git push --tags\n   ```\n   The builds are started in parallel and added to the \"Releases\" page of the GitHub repo (in draft mode).\n\n2. Use the editing feature to publish the new app version.\n\n3. There is no step 3\n\n\n## \u003ca name=\"up-next\"/\u003e\u003c/a\u003e Up Next ![img](https://img.shields.io/badge/proposals-welcome-green.svg?style=flat)\n\n- [ ] \u003cspan style=\"color: cyan;\"\u003eColored Shades\u003c/span\u003e\n- [ ] In-App Updates (Squirrel)\n- [ ] Signed binaries\n- [ ] E2E Testing ([Spectron](https://github.com/electron/spectron))\n\n\n## \u003ca name=\"contribute\"/\u003e\u003c/a\u003e Contact ![Contributions Wanted](https://img.shields.io/badge/contributions-wanted-red.svg?style=flat)\n\n* [Gitter](https://gitter.im/sidneys/desktop-dimmer) Developer Chat\n* [Issues](https://github.com/sidneys/desktop-dimmer/issues) File, track and discuss features and issues\n* [Wiki](https://github.com/sidneys/desktop-dimmer/wiki) Read or contribute to the project Wiki\n\n\n## \u003ca name=\"author\"/\u003e\u003c/a\u003e Author\n\n[sidneys](https://sidneys.github.io) 2016\n","funding_links":[],"categories":["Apps"],"sub_categories":["Open Source"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidneys%2Fdesktop-dimmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidneys%2Fdesktop-dimmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidneys%2Fdesktop-dimmer/lists"}