{"id":19417237,"url":"https://github.com/thewisker/shikai","last_synced_at":"2025-04-24T13:33:34.549Z","repository":{"id":149810017,"uuid":"617121764","full_name":"TheWisker/Shikai","owner":"TheWisker","description":"Modern lightdm webkit2 theme","archived":false,"fork":false,"pushed_at":"2024-04-13T01:07:06.000Z","size":100949,"stargazers_count":75,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T00:42:24.320Z","etag":null,"topics":["archy","lightdm","lightdm-webkit2-greeter-theme","linux","nody-greeter","theme","web-greeter","web-greeter-theme"],"latest_commit_sha":null,"homepage":"https://thewisker.github.io/Shikai/","language":"JavaScript","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/TheWisker.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":null,"support":"SUPPORT.md","governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null}},"created_at":"2023-03-21T18:36:52.000Z","updated_at":"2024-04-15T05:30:01.226Z","dependencies_parsed_at":"2023-10-15T02:44:36.686Z","dependency_job_id":"39b24732-68c2-4192-aa1f-b6efd54e978a","html_url":"https://github.com/TheWisker/Shikai","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheWisker%2FShikai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheWisker%2FShikai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheWisker%2FShikai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheWisker%2FShikai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheWisker","download_url":"https://codeload.github.com/TheWisker/Shikai/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223954798,"owners_count":17231189,"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":["archy","lightdm","lightdm-webkit2-greeter-theme","linux","nody-greeter","theme","web-greeter","web-greeter-theme"],"created_at":"2024-11-10T13:08:15.809Z","updated_at":"2024-11-10T13:08:16.359Z","avatar_url":"https://github.com/TheWisker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eShikai\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/TheWisker/Shikai\"\u003e\n        \u003cimg width=\"400\" src=\"./assets/logo.png\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\u003cp align=\"center\"\u003eModern lightdm webkit2 theme\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003eIndex\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \n  [Description][description]\n  \n  [Features][features]\n\n  [Live Demo][livedemo]\n  \n  [Screenshots][screenshots]\n  \n  [Installation][installation]\n\n  [Updating][updating]\n  \n  [Dependencies][dependencies]\n\n  [Configuration][configuration]\n\n  [Discussions][discussions]\n\n  [Troubleshooting][troubleshooting]\n\n  [Contributions][contributions]\n\n  [Translations][translations]\n\n  [Metrics][metrics]\n\n  [Notes][notes]\n\n  [License][license]\n  \n  [Code of Conduct][coc]\n  \n  [Author][author]\n\n\u003c/div\u003e\n\n\u003ch2 align=\"center\"\u003eDescription [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003eThis is a sleek \u003cb\u003elightdm webkit2 theme\u003c/b\u003e that focuses on it's looks with performance in mind.\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003eFeatures [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nThe theme features:\n\n- **Draggable** windows!\n- **Multi-monitor** support!\n- **Multi-language** support!\n- Custom **time and date** formats!\n- Graphical on-theme **behaviour** configuration!\n- Graphical on-theme **styles** configuration!\n- Saving configurations as **sub-themes**!\n- **Sleek animations** and **on-hover effects**!\n- Background **shuffle** on background click!\n- Idle login window **auto-hiding** at 60s of inactivity!\n- **Custom backgrounds** configured via *web-greeter.yml*!\n- **Custom user images** configured via a *.face* image on user home folders!\n\n\u003ch2 align=\"center\"\u003eLive Demo [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n- Demo password: `password`\n\n\u003cp align=\"center\"\u003ehttps://thewisker.github.io/Shikai\u003c/p\u003e\n\n- The demo wallpapers do **not fit** on some **aspect ratios**, thus look out of place, but that can be **fixed** when the theme is installed by **changing** the **wallpapers** for ones with the correct aspect ratios.\n\n\u003ch2 align=\"center\"\u003eScreenshots [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n![Main theme screenshot](./assets/screenshots/Screenshot_One.png)\n\n![Behaviour settings screenshot](./assets/screenshots/Screenshot_Two.png)\n\n![Style settings screenshot](./assets/screenshots/Screenshot_Three.png)\n\n![Themes settings screenshot](./assets/screenshots/Screenshot_Four.png)\n\n![Second main screenshot](./assets/screenshots/Screenshot_Five.png)\n\n\u003ch2 align=\"center\"\u003eInstallation [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nIf not installing through the [AUR][aur] you need to:\nOnce all [dependencies][dependencies] are installed, **download** a [release][releases]. Then, **uncompress** said release into a resulting folder.\n\n\u003ch3\u003eArch Linux\u003c/h3\u003e\n\nYou can install **Shikai** from the [AUR][aur] repository:\n\n\u003ca href=\"https://aur.archlinux.org/packages/web-greeter-theme-shikai\"\u003e\n\u003cimg src=\"https://camo.githubusercontent.com/f4b1ed57afad4fc0cc6f7acbfdf76be7bebaa104563e1e756ba7b91095eec461/68747470733a2f2f692e696d6775722e636f6d2f3958416a6330482e706e67\" height=48px/\u003e\n\u003c/a\u003e\n\n- For information on how to install an [AUR][aur] package read [this][aur-wiki] wiki.\n\nThen you should **edit** `/etc/lightdm/web-greeter.yml` to your liking **focusing** on the following lines:\n\n- `theme: shikai`\n- `background_images_dir: /usr/share/web-greeter/themes/shikai/assets/media/wallpapers/`\n- `logo_image: /usr/share/web-greeter/themes/shikai/assets/media/logos/`\n\nThen, to set up a user **profile** image, copy the desired image to the user's **home** directory renaming it to `.face`.\n\n\u003ch3\u003eScript\u003c/h3\u003e\n\nTo install using the scripts just **execute** the following **bash** files under `./scripts` from the release **root** directory.\n\n- `./scripts/w_install.sh` To install using **[web-greeter][web-greeter]**.\n- `./scripts/n_install.sh` To install using **[nody-greeter][nody-greeter]**.\n\nThen, to set up a user **profile image**, copy the desired image to the user's **home** directory renaming it to `.face`.\n\n\u003ch3\u003eManually\u003c/h3\u003e\n\nFirst, go to the `dist` **directory** located on the release folder and **open** the `index.html` and `monitor.html`files. **Search** in both files for `window.__is_debug = true;` and **change** it to `window.__is_debug = false;`. Then, **copy** the `dist` folder **to** `/usr/share/web-greeter/themes/`, **renaming** it from `dist` to `shikai`. Then, you need to **change** the **line** starting with `greeter-session=` in `/etc/lightdm/lightdm.conf` to `greeter-session=web-greeter` or `greeter-session=nody-greeter`, depending on **which** you have installed. Finally, you should **edit** `/etc/lightdm/web-greeter.yml` to your liking **focusing** on the following lines:\n\n- `theme: shikai`\n- `background_images_dir: /usr/share/web-greeter/themes/shikai/assets/media/wallpapers/`\n- `logo_image: /usr/share/web-greeter/themes/shikai/assets/media/logos/`\n\nAlso, to set up a user **profile** image, copy the desired image to the user's **home** directory renaming it to `.face`.\n\n\u003ch2 align=\"center\"\u003eUpdating [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nWhen updating **Shikai** just keep in mind that if the **new** version contains **breaking changes** you must **delete localStorage** with the button in the settings panel **before** making the **update**. Apart from that, just update it as if you were [installing][installation] it *overwriting* in the case of a **manual** install.\n\n\u003ch2 align=\"center\"\u003eDependencies [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n\u003ch3 align=\"left\"\u003eBuildtime\u003c/h3\u003e\n\nThe **Shikai** theme has no *buildtime* dependencies.\n\n\u003ch3 align=\"left\"\u003eRuntime\u003c/h3\u003e\n\nThe theme **depends** on [web-greeter][web-greeter] or [nody-greeter][nody-greeter] and their **respective** dependencies, plus [lightdm][lightdm].\n\n\u003ch2 align=\"center\"\u003eConfiguration [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nThe configuration **button** becomes avaiable by **hovering** over the **top-left corner** of the window. The **behaviour** and **style** settings are **saved** locally **only** when the configuration panel gets **closed**. The **themes** configuration gets saved on theme **creation**, **deletion** and **activation**.\n\n\u003ch2 align=\"center\"\u003eDiscussions [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nFeel free to give any **ideas** for future **improvements** [here][discussion-ideas],\nask any **questions** you have [here][discussion-questions] and\npost **screenshots** of your theme designs [here][discussion-screenshots].\n\n\u003ch2 align=\"center\"\u003eTroubleshooting [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n- **Profile** image **not loading**:\n\nIf you have **added** a .face **image** to you **home** folder and it does **not load** on theme it is probably due to the access **permisions** of the .face **file**. To **fix** this issue, **copy** the .face **image** to `/var/lib/AccountsService/icons/` **renaming** it to your user's **name**. Once done, change its **permisions** with `chmod 644 /var/lib/AccountsService/icons` and `chmod 644 /var/lib/AccountsService/icons/username`. Lastly, **create/modify** the following **configuration** file `/var/lib/AccountsService/users/username` **including** the following line: `Icon=/var/lib/AccountsService/icons/username`\n\n- **Incomplete** loading:\n\nOn the **odd case** that the demo or the theme itself only loads the backgrounds or does not load the settings, it is most probably **due to** a recent **update** that contains changes to the **settings** JSON **structure**. This can be **fixed** manually, looking at the errors in the developer console, and manually **adding** the **missing** keys and values, or **easier** by [deleting the page's localStorage](https://intercom.help/scoutpad/en/articles/3478364-how-to-clear-local-storage-of-web-browser).\n\n\u003ch2 align=\"center\"\u003eContributions [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nFirst and foremost, all contributions are welcome!\nThe **steps** involved when making a contribution are **explained** in the [CONTRIBUTING.md][contributing] file.\nWe look forward to your contributions!\n\n- The **contributors** list is located [here][contributors].\n\n\u003ch2 align=\"center\"\u003eTranslations [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\nSecondly, all translations are also welcome!\nThe **steps** involved when making a translation are **explained** in the [CONTRIBUTING.md][contributing] file.\nMore **specific steps** can be found in the [CONTRIBUTING.md][lang-contributing] file in the `/src/lang` folder.\nWe look forward to your translations!\n\n- The **credits** of the translators are located [here][translator-credits].\n\n\u003ch2 align=\"center\"\u003eMetrics [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003cimg src=\"./assets/metrics/base.svg\"/\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003cimg src=\"./assets/metrics/languages.svg\"/\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n\n\u003ch2 align=\"center\"\u003eNotes [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n- **Change** wallpapers by **adding** or **removing** from `/usr/share/web-greeter/themes/shikai/assets/media/wallpapers/` path!\n- **Undefined** behaviour for adding **non-browser-compliant** images and **non-image** files to the **wallpapers** directory!\n- Missing linux **distro** logo? **Submit** a [pull request][pull-request]!\n- Missing **language**? **Submit** a [pull request][pull-request] including it in `./src/lang`! Further details [here][translations].\n- Have a really cool wallpaper to **add** to the **live demo**? **Submit** a [pull request][pull-request]!\n\n\u003ch2 align=\"center\"\u003eLicense [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003cimg src=\"./assets/metrics/licenses.svg\"/\u003e\n  \u003c/picture\u003e\n\u003c/div\u003e\n\n\u003ch2 align=\"center\"\u003eCode of Conduct [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e This project follows the \u003ca href=\"./.github/CODE_OF_CONDUCT.md\"\u003e\u003cb\u003eContributor Covenant Code of Conduct\u003c/b\u003e\u003c/a\u003e.\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003eAuthor [\u003ca href=\"https://github.com/TheWisker/Shikai#index\"\u003e↑\u003c/a\u003e]\u003c/h2\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/TheWisker\"\u003e\n        \u003cimg width=\"200\" height=\"200\" src=\"./assets/profile.png\"\u003e\u003c/img\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\u003ch4 align=\"center\"\u003eTheWisker\u003c/h4\u003e\n\n[description]: https://github.com/TheWisker/Shikai#description-\n[features]: https://github.com/TheWisker/Shikai#features-\n[livedemo]: https://github.com/TheWisker/Shikai#live-demo-\n[screenshots]: https://github.com/TheWisker/Shikai#screenshots-\n[installation]: https://github.com/TheWisker/Shikai#installation-\n[updating]: https://github.com/TheWisker/Shikai#updating-\n[dependencies]: https://github.com/TheWisker/Shikai#dependencies-\n[configuration]: https://github.com/TheWisker/Shikai#configuration-\n[discussions]: https://github.com/TheWisker/Shikai#discussions-\n[troubleshooting]: https://github.com/TheWisker/Shikai#troubleshooting-\n[contributions]: https://github.com/TheWisker/Shikai#contributions-\n[translations]: https://github.com/TheWisker/Shikai#translations-\n[metrics]: https://github.com/TheWisker/Shikai#metrics-\n[notes]: https://github.com/TheWisker/Shikai#notes-\n[license]: https://github.com/TheWisker/Shikai#license-\n[coc]: https://github.com/TheWisker/Shikai#code-of-conduct-\n[author]: https://github.com/TheWisker/Shikai#author-\n[aur]: https://aur.archlinux.org/\n[aur-wiki]: https://wiki.archlinux.org/title/Arch_User_Repository\n[releases]: https://github.com/TheWisker/Shikai/releases/\n[web-greeter]: https://github.com/JezerM/web-greeter\n[nody-greeter]: https://github.com/JezerM/nody-greeter\n[lightdm]: https://github.com/canonical/lightdm\n[discussion-ideas]: https://github.com/TheWisker/Shikai/discussions/categories/ideas\n[discussion-questions]: https://github.com/TheWisker/Shikai/discussions/categories/q-a\n[discussion-screenshots]: https://github.com/TheWisker/Shikai/discussions/2#discussion-5044383\n[contributing]: ./CONTRIBUTING.md\n[contributors]: ./CONTRIBUTORS.md\n[lang-contributing]: ./src/lang/CONTRIBUTING.md\n[translator-credits]: ./src/lang/credits.js\n[pull-request]: https://github.com/TheWisker/Shikai/pulls","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthewisker%2Fshikai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthewisker%2Fshikai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthewisker%2Fshikai/lists"}