{"id":13439565,"url":"https://github.com/Raymo111/i3lock-color","last_synced_at":"2025-03-20T08:31:33.774Z","repository":{"id":38828207,"uuid":"51324168","full_name":"Raymo111/i3lock-color","owner":"Raymo111","description":"The world's most popular non-default computer lockscreen.","archived":false,"fork":true,"pushed_at":"2025-03-10T00:01:47.000Z","size":1726,"stargazers_count":1113,"open_issues_count":28,"forks_count":139,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-10T01:27:54.260Z","etag":null,"topics":["autotools","bsd","c","cairo","i3","i3-wm","i3lock","i3lock-color","linux","lockscreen"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"i3/i3lock","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Raymo111.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null},"funding":{"github":["Raymo111"]}},"created_at":"2016-02-08T20:17:17.000Z","updated_at":"2025-03-10T00:01:51.000Z","dependencies_parsed_at":"2023-02-14T15:46:12.846Z","dependency_job_id":null,"html_url":"https://github.com/Raymo111/i3lock-color","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raymo111%2Fi3lock-color","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raymo111%2Fi3lock-color/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raymo111%2Fi3lock-color/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raymo111%2Fi3lock-color/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Raymo111","download_url":"https://codeload.github.com/Raymo111/i3lock-color/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244577829,"owners_count":20475368,"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":["autotools","bsd","c","cairo","i3","i3-wm","i3lock","i3lock-color","linux","lockscreen"],"created_at":"2024-07-31T03:01:15.181Z","updated_at":"2025-03-20T08:31:33.768Z","avatar_url":"https://github.com/Raymo111.png","language":"C","funding_links":["https://github.com/sponsors/Raymo111"],"categories":["💣 Setup Installation","C","Dependencies","Tool"],"sub_categories":["Needed","Desktop Extension Tool"],"readme":"# i3lock-color\n\n![Language count](https://img.shields.io/github/languages/count/Raymo111/i3lock-color)\n[![Top language](https://img.shields.io/github/languages/top/Raymo111/i3lock-color)](https://github.com/Raymo111/i3lock-color/search?l=c)\n![Repo size](https://img.shields.io/github/repo-size/Raymo111/i3lock-color)\n[![Open issues](https://img.shields.io/github/issues-raw/Raymo111/i3lock-color)](https://github.com/Raymo111/i3lock-color/issues?q=is%3Aopen+is%3Aissue)\n[![Closed issues](https://img.shields.io/github/issues-closed-raw/Raymo111/i3lock-color?color=brightgreen)](https://github.com/Raymo111/i3lock-color/issues?q=is%3Aissue+is%3Aclosed)\n[![Open PRs](https://img.shields.io/github/issues-pr-raw/Raymo111/i3lock-color?label=open%20PRs)](https://github.com/Raymo111/i3lock-color/pulls?q=is%3Aopen+is%3Apr)\n[![Closed PRs](https://img.shields.io/github/issues-pr-closed-raw/Raymo111/i3lock-color?color=brightgreen\u0026label=closed%20PRs)](https://github.com/Raymo111/i3lock-color/pulls?q=is%3Apr+is%3Aclosed)\n[![Contributors](https://img.shields.io/github/contributors/Raymo111/i3lock-color)](https://github.com/Raymo111/i3lock-color/graphs/contributors)\n[![Latest release](https://img.shields.io/github/release-date/Raymo111/i3lock-color?label=latest%20release)](https://github.com/Raymo111/i3lock-color/releases/latest)\n[![Commits](https://img.shields.io/github/commits-since/Raymo111/i3lock-color/latest?include_prereleases\u0026sort=semver)](https://github.com/Raymo111/i3lock-color/commits/master)\n![Latest commit](https://img.shields.io/github/last-commit/Raymo111/i3lock-color)\n[![AUR release ver](https://img.shields.io/aur/version/i3lock-color?label=AUR%20release%20ver\u0026logo=ArchLinux)](https://aur.archlinux.org/packages/i3lock-color/)\n[![AUR git ver](https://img.shields.io/aur/version/i3lock-color-git?label=AUR%20git%20ver\u0026logo=ArchLinux)](https://aur.archlinux.org/packages/i3lock-color-git/)\n![AUR votes](https://img.shields.io/aur/votes/i3lock-color-git?logo=ArchLinux)\n[![GitHub forks](https://img.shields.io/github/forks/Raymo111/i3lock-color?logo=GitHub)](https://github.com/Raymo111/i3lock-color/network/members)\n[![GitHub stars](https://img.shields.io/github/stars/Raymo111/i3lock-color?logo=GitHub)](https://github.com/Raymo111/i3lock-color/stargazers)\n[![GitHub watchers](https://img.shields.io/github/watchers/Raymo111/i3lock-color?logo=GitHub)](https://github.com/Raymo111/i3lock-color/watchers)\n[![Discord server](https://img.shields.io/discord/878461145197977630?label=Discord\u0026logo=Discord)](https://discord.gg/FzVPghyDt2)\n![Maintained](https://img.shields.io/maintenance/yes/9999)\n\u003c!--![Arch Linux package](https://img.shields.io/archlinux/v/community/x86_64/i3lock-color?logo=arch%20linux\u0026label=Community%20version)--\u003e\n\n### The world's most popular non-default computer lockscreen.\n**A modern version of i3lock with color functionality and other features.**\n\n![i3lock-color in action](examples/screenshot.png \"Screenshot sample\")\n\n**NEW: Official Discord server at https://discord.gg/FzVPghyDt2**\n\ni3lock is a simple screen locker like slock. After starting it, you will see a white screen (you can configure the color/an image). You can return to your screen by entering your password.\n\nMany little improvements have been made to i3lock over time:\n\n- i3lock forks, so you can combine it with an alias to suspend to RAM (run \"i3lock \u0026\u0026 echo mem \u003e /sys/power/state\" to get a locked screen after waking up your computer from suspend to RAM)\n- You can specify either a background color or an image (JPG or PNG), which will be displayed while your screen is locked. Note that i3lock is not an image manipulation software. If you need to resize the image to fill the screen, you can use something like ImageMagick combined with `xdpyinfo`:\n\t```bash\n\tconvert image.jpg -resize $(xdpyinfo | grep dimensions | sed -r 's/^[^0-9]*([0-9]+x[0-9]+).*$/\\1/') RGB:- | i3lock --raw $(xdpyinfo | grep dimensions | sed -r 's/^[^0-9]*([0-9]+x[0-9]+).*$/\\1/'):rgb --image /dev/stdin\n\t```\n- You can specify whether i3lock should bell upon a wrong password.\n- i3lock uses PAM and therefore is compatible with LDAP etc. On OpenBSD, i3lock uses the bsd\\_auth(3) framework.\n\n## Additional features in i3lock-color\nYou can also specify additional options, as detailed in the manpage. This includes, but is not limited to:\n\n- Color options for:\n\t- Verification ring\n\t- Interior ring color\n\t- Ring interior line color\n\t- Key highlight color\n\t- Backspace highlight color\n\t- Text colors for most/all strings\n\t- Outline colors\n\t- Changing all of the above depending on PAM's authentication status\n- Blurring the current screen and using that as the lock background    \n- Showing a clock in the indicator\n- Refreshing on a timer, instead of on each keypress\n- Positioning the various UI elements\n- Changing the ring radius and thickness, as well as text size\n- Options for passwordless auth, removing modkey indicator\n- Passing through media keys\n- A new bar indicator, which replaces the ring indicator with its own set of options\n\t- An experimental thread for driving the redraw ticks, so that things like the bar/clock still update when PAM is blocking\n- Any other feature you want (add it yourself through a PR or make a feature request issue!)\n\n## Dependencies\nThe following dependencies will need to be installed for a successful build, depending on your OS/distro.\n\n### Arch Linux\n- autoconf\n- cairo\n- fontconfig\n- gcc\n- libev\n- libjpeg-turbo\n- libxinerama\n- libxkbcommon-x11\n- libxrandr\n- pam\n- pkgconf\n- xcb-util-image\n- xcb-util-xrm\n\n### Debian\nRun this command to install all dependencies:\n```\nsudo apt install autoconf gcc make pkg-config libpam0g-dev libcairo2-dev libfontconfig1-dev libxcb-composite0-dev libev-dev libx11-xcb-dev libxcb-xkb-dev libxcb-xinerama0-dev libxcb-randr0-dev libxcb-image0-dev libxcb-util0-dev libxcb-xrm-dev libxkbcommon-dev libxkbcommon-x11-dev libjpeg-dev libgif-dev\n```\nIf you still see missing packages during build after installing all of these dependencies, try following the steps [here](https://github.com/Raymo111/i3lock-color/issues/211#issuecomment-809891727).\n\n### Fedora\nRun this command to install all dependencies:\n\n```sh\nsudo dnf install -y autoconf automake cairo-devel fontconfig gcc libev-devel libjpeg-turbo-devel libXinerama libxkbcommon-devel libxkbcommon-x11-devel libXrandr pam-devel pkgconf xcb-util-image-devel xcb-util-xrm-devel\n```\n\n### Ubuntu 18/20.04 LTS\nRun this command to install all dependencies:\n```\nsudo apt install autoconf gcc make pkg-config libpam0g-dev libcairo2-dev libfontconfig1-dev libxcb-composite0-dev libev-dev libx11-xcb-dev libxcb-xkb-dev libxcb-xinerama0-dev libxcb-randr0-dev libxcb-image0-dev libxcb-util-dev libxcb-xrm-dev libxkbcommon-dev libxkbcommon-x11-dev libjpeg-dev\n```\n\n## Building i3lock-color\nBefore you build - check and see if there's a packaged version available for your distro (there usually is, either in a community repo/PPA).\n\n**If you want to build a non-debug version, you should tag your build before configuring.**\n\nFor example: `git tag -f \"git-$(git rev-parse --short HEAD)\"` will add a tag with the short commit ID, which will be used for the version info.\n\ni3lock-color uses GNU autotools for building.\n\nTo build/install i3lock-color, first install the dependencies listed above, then clone the repo:\n```\ngit clone https://github.com/Raymo111/i3lock-color.git\ncd i3lock-color\n```\nTo build without installing, run:\n```\n./build.sh\n```\nTo build AND install, run:\n```\n./install-i3lock-color.sh\n```\nYou may choose to modify the script based on your needs/OS/distro.\n\n## Alpine Linux Packages\nAlpine packages i3lock-color for a variety of architectures. A full list can be found on [pkgs.alpinelinux.org](https://pkgs.alpinelinux.org/packages?name=i3lock-color\u0026branch=edge).\n\n## Arch Linux Packages\n~~[Stable version in Community](https://www.archlinux.org/packages/community/x86_64/i3lock-color/)~~\n\nUnfortunately the previous maintainer left, and the package got dumped back into the AUR where I'm now maintaining it. You can get it on AUR:\n- [Release Version on AUR](https://aur.archlinux.org/packages/i3lock-color/)\n- [Git Version on AUR](https://aur.archlinux.org/packages/i3lock-color-git/)\n\nIf you're an Arch TU and you're reading this please consider sponsoring it into Community again!\n\n## Gentoo Linux Package\ni3lock-color is available on **GURU**, under [`x11-misc/i3lock-color`](https://github.com/gentoo/guru/tree/master/x11-misc/i3lock-color).\n\n## Kali Linux Package\nA Debian/Kali package is available: https://gitlab.com/kalilinux/packages/i3lock-color.\n\n## NixOS Package\nA NixOS package is available. To install, run\n```\nnix-env -iA nixos.i3lock-color\n```\n\n## Void Linux Package\nA Void Linux package is available at https://github.com/void-linux/void-packages/tree/master/srcpkgs/i3lock-color.\n\n## FreeBSD port\nA FreeBSD port is available on freshports: [x11/i3lock-color/](https://www.freshports.org/x11/i3lock-color/).\n\n## Running i3lock-color\nSimply invoke the 'i3lock' command. To get out of it, enter your password and press enter.\n\nA [sample script](examples/lock.sh) is included in this repository.\n\nOn OpenBSD the `i3lock` binary needs to be setgid `auth` to call the authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.\n\n## Contributors\nThis project was started by [eBrnd](https://github.com/eBrnd/i3lock-color), maintained for a few years by [PandorasFox](https://github.com/PandorasFox) and now maintained and being developed by [Raymo111](https://github.com/Raymo111). The full list of contributors can be found [here](https://github.com/Raymo111/i3lock-color/graphs/contributors).\n\n## Upstream\nPlease submit pull requests for i3lock things to [https://github.com/i3/i3lock](https://github.com/i3/i3lock) and pull requests for additional features on top of regular i3lock at [https://github.com/Raymo111/i3lock-color](https://github.com/Raymo111/i3lock-color).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRaymo111%2Fi3lock-color","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRaymo111%2Fi3lock-color","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRaymo111%2Fi3lock-color/lists"}