{"id":16904443,"url":"https://github.com/kurtmckee/dotbot-windows","last_synced_at":"2025-09-11T08:43:24.539Z","repository":{"id":181111800,"uuid":"666241508","full_name":"kurtmckee/dotbot-windows","owner":"kurtmckee","description":"Configure Windows using dotbot","archived":false,"fork":false,"pushed_at":"2025-08-06T13:27:19.000Z","size":176,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-18T10:52:55.199Z","etag":null,"topics":["dotbot","dotbot-plugin","dotfiles","windows"],"latest_commit_sha":null,"homepage":"","language":"Python","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/kurtmckee.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","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,"zenodo":null},"funding":{"github":"kurtmckee","ko_fi":"kurtmckee"}},"created_at":"2023-07-14T03:34:32.000Z","updated_at":"2025-07-08T14:07:40.000Z","dependencies_parsed_at":"2024-02-01T18:04:46.169Z","dependency_job_id":"76b4a747-8375-4e45-9e6a-b96c75cd346c","html_url":"https://github.com/kurtmckee/dotbot-windows","commit_stats":null,"previous_names":["kurtmckee/dotbot-windows"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/kurtmckee/dotbot-windows","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtmckee%2Fdotbot-windows","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtmckee%2Fdotbot-windows/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtmckee%2Fdotbot-windows/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtmckee%2Fdotbot-windows/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kurtmckee","download_url":"https://codeload.github.com/kurtmckee/dotbot-windows/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kurtmckee%2Fdotbot-windows/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274602801,"owners_count":25315205,"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","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dotbot","dotbot-plugin","dotfiles","windows"],"created_at":"2024-10-13T18:33:25.034Z","updated_at":"2025-09-11T08:43:24.528Z","avatar_url":"https://github.com/kurtmckee.png","language":"Python","funding_links":["https://github.com/sponsors/kurtmckee","https://ko-fi.com/kurtmckee"],"categories":[],"sub_categories":[],"readme":"..  dotbot-windows -- Configure Windows using dotbot.\n..  Copyright 2023-2025 Kurt McKee \u003ccontactme@kurtmckee.org\u003e\n..  SPDX-License-Identifier: MIT\n\n\ndotbot-windows\n##############\n\nConfigure Windows using `dotbot`_.\n\n-------------------------------------------------------------------------------\n\n\nTable of contents\n=================\n\n*   `What you can do with it`_\n*   `Installation`_\n*   `Configuration`_\n*   `Development`_\n\n\nWhat you can do with it\n=======================\n\nThe dotbot-windows plugin is able to configure Windows in the following ways:\n\n*   Configure the desktop background color\n*   Import registry files (``*.reg``) from a specified directory\n*   Install fonts (TrueType and OpenType formats) from a specified directory\n\nSample configuration:\n\n..  code-block:: yaml\n\n    windows:\n      personalization:\n        background-color: \"#2A4661\"\n\n      registry:\n        import: \"my-registry-tweaks/\"\n\n      fonts:\n        path: \"my-standard-fonts/\"\n\n\nInstallation\n============\n\nThere are two ways to install and use the plugin:\n\n1.  Install it as a Python package.\n2.  Add it as a git submodule in your dotfiles repository.\n3.  Copy ``dotbot_windows.py`` into your dotfiles directory.\n\n\nPython package\n--------------\n\nIf you want to install dotbot-windows as a Python package\n(for example, if you're using a virtual environment),\nthen you can install the plugin using ``pip``:\n\n..  code-block::\n\n    pip install dotbot-windows\n\nThen, when running dotbot, use the ``-p`` or ``--plugin`` option\nto tell dotbot to load the plugin:\n\n..  code-block::\n\n    dotbot [...] --plugin dotbot_windows [...]\n\nIf you're using one of dotbot's ``install`` scripts,\nyou'll need to edit that file to add the ``--plugin`` option.\n\n\nGit submodule\n-------------\n\nIf you want to track dotbot-windows as a git submodule\n(for example, if you manage your dotfiles using git)\nthen you can add the plugin repository as a submodule using ``git``:\n\n..  code-block::\n\n    git submodule add https://github.com/kurtmckee/dotbot-windows.git\n\nThis will clone the repository to a directory named ``dotbot-windows``.\nThen, when running dotbot, use the ``-p`` or ``--plugin`` option\nto tell dotbot to load the plugin:\n\n..  code-block::\n\n    dotbot [...] --plugin dotbot-windows/dotbot_windows.py [...]\n\nNote that you may need to initialize the plugin's git submodule\nwhen you clone your dotfiles repository or pull new changes\nto another computer.\nThe command for this will look something like:\n\n..  code-block::\n\n    git submodule update --init dotbot-windows\n\n\nCopy ``dotbot_windows.py``\n--------------------------\n\nIf desired, you can copy ``dotbot_windows.py`` to your dotfiles directory.\nYou might choose to do this if you already use other plugins\nand have configured dotbot to load all plugins from a plugin directory.\n\nIf you copy ``dotbot_windows.py`` to the root of your dotfiles directory\nthen, when running dotbot, use the ``-p`` or ``--plugin`` option\nto tell dotbot to load the plugin:\n\n..  code-block::\n\n    dotbot [...] --plugin dotbot_windows.py [...]\n\nIf you copy ``dotbot_windows.py`` to a directory containing other plugins,\nyou can use dotbot's ``--plugin-dir`` option to load all plugins in the directory.\nIn the example below, the plugin directory is named ``dotbot-plugins``:\n\n..  code-block::\n\n    dotbot [...] --plugin-dir dotbot-plugins [...]\n\n\nConfiguration\n=============\n\n**Personalization**\n\nYou can configure the desktop background color using a hexadecimal color (like ``\"#2A4661\"``)\nor a triplet of decimal RGB values (like ``\"0 153 255\"``).\n\nHere are examples demonstrating the two formats:\n\n..  code-block:: yaml\n\n    windows:\n        personalization:\n            background-color: \"#2A4661\"\n\n..  code-block:: yaml\n\n    windows:\n        personalization:\n            background-color: \"42 70 97\"\n\n**Registry**\n\nYou can import registry files by specifying a directory containing ``*.reg`` files.\nThe directory will be recursively searched for ``*.reg`` files,\nand each of them will be imported.\n\nNote that registry imports may fail if the changes require administrator privileges.\n\nHere's a dotbot configuration file example:\n\n..  code-block:: yaml\n\n    windows:\n        registry:\n            import: \"registry-export-files\"\n\n\n**Fonts**\n\nStarting with Windows 10 build 17704, users can `install fonts without admin permissions`_.\nThe fonts can be copied into ``\"%LOCALAPPDATA%/Microsoft/Windows/Fonts\"``\nand installed via the Windows registry.\n\nHere's a dotbot configuration file example:\n\n..  code-block:: yaml\n\n    windows:\n      fonts:\n        path: \"my-standard-fonts/\"\n\n\nDevelopment\n===========\n\nTo set up a development environment, clone the dotbot-windows plugin's git repository.\nThen, follow these steps to create a virtual environment and run the test suite:\n\n..  code-block:: shell\n\n    # Create the virtual environment\n    $ python -m venv .venv\n\n    # Activate the virtual environment (Windows-only)\n    $ \u0026 .venv/Scripts/Activate.ps1\n\n    # Update pip and setuptools, and install wheel\n    (.venv) $ pip install -U pip setuptools wheel\n\n    # Install poetry, tox, and scriv\n    (.venv) $ pip install poetry tox scriv\n\n    # Install all dependencies\n    (.venv) $ poetry install\n\n    # Run the unit tests locally\n    (.venv) $ tox\n\n\n..  Links\n..  =====\n..\n..  _dotbot: https://github.com/anishathalye/dotbot\n..  _install fonts without admin permissions: https://blogs.windows.com/windows-insider/2018/06/27/announcing-windows-10-insider-preview-build-17704/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurtmckee%2Fdotbot-windows","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkurtmckee%2Fdotbot-windows","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkurtmckee%2Fdotbot-windows/lists"}