{"id":20775810,"url":"https://github.com/nickgeek/oled-shmoled","last_synced_at":"2025-07-04T00:05:40.783Z","repository":{"id":46109833,"uuid":"320513346","full_name":"NickGeek/oled-shmoled","owner":"NickGeek","description":"OLED displays don't have backlights but it'd be nice if we could pretend they do on Linux!","archived":false,"fork":false,"pushed_at":"2021-11-14T04:36:29.000Z","size":50,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-04T00:05:35.388Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NickGeek.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}},"created_at":"2020-12-11T08:30:45.000Z","updated_at":"2023-12-31T04:05:29.000Z","dependencies_parsed_at":"2022-09-15T14:22:38.901Z","dependency_job_id":null,"html_url":"https://github.com/NickGeek/oled-shmoled","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/NickGeek/oled-shmoled","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickGeek%2Foled-shmoled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickGeek%2Foled-shmoled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickGeek%2Foled-shmoled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickGeek%2Foled-shmoled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NickGeek","download_url":"https://codeload.github.com/NickGeek/oled-shmoled/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickGeek%2Foled-shmoled/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263421921,"owners_count":23464048,"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-11-17T12:39:12.107Z","updated_at":"2025-07-04T00:05:40.678Z","avatar_url":"https://github.com/NickGeek.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OLED Shmoled\nOLED displays don't have backlights but it'd be nice if we could pretend they do on Linux!\n\nThis program aims to be very light weight and configurable. The easiest way to use it would be to make it run on startup.\nThe only external dependency is `xrandr`.\n\n## Install\nYou can get an x86_64 Linux (ELF) binary from the [releases page](https://github.com/NickGeek/oled-shmoled/releases).\n\nAlternatively, the program is [available on the AUR](https://aur.archlinux.org/packages/oled_shmoled/)\nand on [crates.io](https://crates.io/crates/oled_shmoled) via `cargo install oled_shmoled`.\n\n## Usage\n```\n$ oled_shmoled --help\nOLED shmoled 0.1.0\nNick Webster \u003cnick@nick.geek.nz\u003e\n\nUSAGE:\n    oled_shmoled [OPTIONS] \u003cmonitor-ident\u003e\n\nARGS:\n    \u003cmonitor-ident\u003e    The xrandr identifier for the display\n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n\nOPTIONS:\n        --base-path \u003cbase-path\u003e\n            The base path for the backlight files [default: /sys/class/backlight/intel_backlight]\n\n        --current-brightness-file \u003ccurrent-brightness-file\u003e\n            The name of the file containing the current backlight state [default: brightness]\n\n        --max-brightness-file \u003cmax-brightness-file\u003e\n            The name of the file identifying the maximum brightness of the system [default:\n            max_brightness]\n```\n\n```\n$ xrandr\nScreen 0: minimum 8 x 8, current 4608 x 4752, maximum 32767 x 32767\neDP1 connected primary 3840x2160+266+2592 (normal left inverted right x axis y axis) 340mm x 190mm\n# ...etc...\n```\n\n```\n$ oled_shmoled eDP1\nWatching /sys/class/backlight/intel_backlight for backlight changes…\n```\n\nThe easiest way to use OLED Shmoled is to run that last command at start-up. This can be done by running it in an\n`.xinitrc` or a systemd job.\n\nOn window managers like i3 you can add the following to your i3 configs to get the brightness keys working:\n```\nbindsym XF86MonBrightnessDown exec --no-startup-id xbacklight -dec 5\nbindsym XF86MonBrightnessUp exec --no-startup-id xbacklight -inc 5\n```\n\n## Build instructions\n```\n$ git clone https://github.com/NickGeek/oled-shmoled oled_shmoled\n$ cd oled_shmoled\n$ cargo build --release\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickgeek%2Foled-shmoled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickgeek%2Foled-shmoled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickgeek%2Foled-shmoled/lists"}