Windots

<h3> <div align="center"> <img src="./.github/assets/title.png" alt="title"> <br>

A Windows 11 Dotfiles Repo infused with <a href="https://catppuccin.com/">Catppuccin</a> Theme <a href="https://twitter.com/intent/tweet?text=Windows%2011%20Dotfiles%20Infused%20With%20Catppuccin%20Theme&url=https://github.com/jacquindev/windots"><img src="https://img.shields.io/badge/Tweet-share-8AADF4?style=social&logo=x&logoColor=8AADF4&labelColor=302D41&color=8AADF4" alt="TWITTER"></a>  

</div> <br> </h3> <div align="center"> <p> <a href="https://github.com/jacquindev/commits/main"><img alt="Last Commit" src="https://img.shields.io/github/last-commit/jacquindev/windots?style=for-the-badge&logo=github&logoColor=EBA0AC&label=Last%20Commit&labelColor=302D41&color=EBA0AC"></a>&nbsp;&nbsp; <a href="https://github.com/jacquindev/windots/"><img src="https://img.shields.io/github/repo-size/jacquindev/windots?style=for-the-badge&logo=hyprland&logoColor=F9E2AF&label=Size&labelColor=302D41&color=F9E2AF" alt="REPO SIZE"></a>&nbsp;&nbsp; <a href="https://github.com/jacquindev/windots/LICENSE"><img src="https://img.shields.io/github/license/jacquindev/windots?style=for-the-badge&logo=&color=CBA6F7&logoColor=CBA6F7&labelColor=302D41" alt="LICENSE"></a>&nbsp;&nbsp; <a href="https://github.com/jacquindev/windots/stargazers"><img alt="Stargazers" src="https://img.shields.io/github/stars/jacquindev/windots?style=for-the-badge&logo=starship&color=B7BDF8&logoColor=B7BDF8&labelColor=302D41"></a>&nbsp;&nbsp; </p> </div> <hr>

[!IMPORTANT] The below screenshots are taken on my main monitor, which has the resolution of 3440x1440. Configurations in this repository seem to work seamlessly on my 1920x1080 monitors as well.

<br> <div align="center"> <a href="#preview"><kbd> <br> 🌆 Preview <br> </kbd></a>&ensp;&ensp; <a href="#install"><kbd> <br> 🌷 Install <br> </kbd></a>&ensp;&ensp; <a href="#extras"><kbd> <br> 🧱 Extras <br> </kbd></a>&ensp;&ensp; <a href="#features"><kbd> <br> ✨ Features <br> </kbd></a>&ensp;&ensp; <a href="#credits"><kbd> <br> 🎉 Credits <br> </kbd></a>&ensp;&ensp; <a href="#author"><kbd> <br> 👤 Author <br> </kbd></a>&ensp;&ensp; </div> <hr>

⚠️ Disclaimer

Since I work with this repository everyday to maintain latest updates for my Windows machine, many apps or packages will be add / remove / reconfigure to fit my personal taste.

So, please keep in mind that:

• This repository is under very active development.
• You might expect bugs and breaking changes.

<br>

✨ Prerequisites

• Git for Windows
• PowerShell 7

Highly Recommended:

• Windows Terminal or Windows Terminal Preview

<br> <h2 id="preview">🌆 Preview</h2>

• 2 status bar options: Rainmeter / Yasb

Yasb's Catppuccin Statusbar

<br/><br/> <br/><br/> <br/><br/> <br/><br/>

Rainmeter's Catppuccin Statusbar

<br/><br/> <br/><br/> <br/><br/>

• Transparent File Explorer

ExplorerBlurMica + Catppuccin Themes

<hr> <h2 id="install">🌷 Install</h2>

• Simply clone this repo to your_location

git clone https://github.com/jacquindev/windots.git your_location
cd `your_location`

• In your elevated PowerShell Terminal, run: .\Setup.ps1

. .\Setup.ps1

<h4>⁉️ Overriding Defaults</h4>

[!IMPORTANT] Before running the Setup.ps1 script, please check the appList.json file to ADD/REMOVE the apps you would like to install.<br/>

<b><i><ins>VSCode Extensions:</ins></i></b><br/> Edit the VSCode's extensions list to ADD/REMOVE the extensions you would like to install.

<br> <details open> <summary><b>😎 Clink Setup</b></summary>

• In your Command Prompt console, type:

  clink installscripts "your_location\clink\clink-custom"
  clink installscripts "your_location\clink\clink-completions"
  clink installscripts "your_location\clink\clink-gizmos"
  clink installscripts "your_location\clink\more-clink-completions"
  

• Replace your_location with full path to where you cloned this repository.

</details>

[!NOTE] The clink-custom directory contains Lua scripts to extend clink based on the programs you use. If you do not have the programs define in the scripts, they will not be activated.

• custom prompt ➝ clink/clink-custom/prompt.lua. (Only one of the following should be set to true, otherwise false)
  • oh-my-posh: to enable, set local ohmyposh_enabled = true.
  • starship: to enable, set local starship_enabled = true.
• vfox ➝ clink/clink-custom/vfox.lua
• zoxide ➝ clink/clink-custom/zoxide.lua

<br> <details open> <summary><b>⛏ Setup Development Tools with MISE <i>(mise-en-place)</i></b></summary> <br>

Ensure that mise command available on your system (using scoop install mise)

# Enable experimental features:
mise settings experimental true

The below command with install latest LTS version of NodeJS, and also automatically install NPM global packages define in .default-npm-packages

# Install latest NodeJS LTS
mise use -g node@lts

For further information please visit: https://mise.jdx.dev.

<br> <details open> <summary><b>🌟 Bootstrap WSL</b></summary> <br>

WSL setup can be done automatically by using Ansible. Any details can be found here: https://github.com/jacquindev/automated-wsl2-setup.

➝ WSL dotfiles are maintained in this repository: https://github.com/jacquindev/dotfiles.

</details> <br> <h3 id="extras">⛏🧱 Extra Setup (optional)</h3>

Follow the below links to download and learn to how to setup:

<details> <summary><b>🌈 Catppuccin Themes 🎨</b></summary> <br> <div align="center"> <table> <tr> <td><a href="https://www.deviantart.com/niivu/art/Catppuccin-Cursors-921387705">Cursors</a></td> <td><img src="./.github/assets/cursors.png" alt="cursors"></td> </tr> <tr> <td><a href="https://www.deviantart.com/niivu/art/Catppuccin-for-Windows-11-1076249390">Themes</a></td> <td><img src="./.github/assets/themes.png" alt="themes"></td> </tr> </table> </div> </details> <details> <summary><b>🎸 Spicetify Setup 🎧</b></summary> <br> <div align="left"> <table> <tr> <th>Addons</th> <th>Name</th> </tr> <tr> <td>Extensions</td> <td> <a href="https://github.com/surfbryce/beautiful-lyrics">Beautiful Lyrics</a>&nbsp; <a href="https://github.com/spicetify/cli">Bookmark</a>&nbsp; <a href="https://github.com/huhridge/huh-spicetify-extensions">Full App Display</a>&nbsp; <a href="https://github.com/spicetify/cli">Shuffle+</a>&nbsp; <a href="https://github.com/spicetify/cli">Trash Bin</a>&nbsp; </td> </tr> <td>Themes</td> <td> <a href="https://github.com/Comfy-Themes/Spicetify">Comfy Themes</a>&nbsp; <a href="./config/config/spicetify/comfy.js">⚙️</a> </td> <tr> </tr> </table> </div> </details> <br> <h2 id="features">✨ Features</h2>

• 💫 All packages to install are listed in appList.json file - Easy to maintain!
• 🎨 Main theme Catppuccin for everything!
• 🎀 Minimal Yasb status bar
• 💖 Beautiful wallpapers, and live wallpapers for Lively Wallpapers
• 🪟 Komorebi config
• 🌸 All-In-One VSCode setup (extensions list)
• ⚙️ Rainmeter setup
• >_ Sleek Windows Terminal config
• 🌈 Oh-My-Posh minimal theme (with Spotify status if playing)
• 🦄 Super fast PowerShell startup time (load asynchronously) + custom configurations & modules
• 🍄 Simple fastfetch configuration, which I copied from scottmckendry's config
• 🥂 Many addons for Git!
• 🐱 Use MISE (mise-en-place) to manage development tools. Learn more about mise here: https://mise.jdx.dev/

<details open> <br> <summary><b>🖥️ CLI/TUI Apps</b></summary>

| Entry | App | | --------------------- | --------------------------------------------------------------------------------------------- | | Terminal Emulator | Windows Terminal ⚙️ | | File Explorer | yazi ⚙️ | | Fuzzy File Finder | fzf