.config

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 64 Open GitHub ↗

All my Windows dotfiles and how to set them up.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

https://github.com/user-attachments/assets/9cc1e7b9-8ae9-40cd-bf11-87ae4bc6b123

</div>

# System
> [!NOTE]
> Every folder in this repository is located locally at `$Env:USERPROFILE\.config`.

### Dependencies
- 7Zip &rightarrow; Run `winget install --id 7zip.7zip`.
- PowerToys &rightarrow; Run `winget install Microsoft.PowerToys --source winget`.

### Setup
1. Ensure you are able to access and use the Windows Store, winget relies on this for certain things. If you can't
   access the store (it's known to be glitchy for some accounts) then you can find alternative installs for all
   dependencies on either [Chocolatey](https://chocolatey.org/install#individual) or the dependency's official website.
2. Go to the "System" and then "Advanced" section of the Windows settings and do the following:
   - Ensure "Developer Mode" is turned on.
   - Ensure "Enable long paths" is turned on.
   - Enable "Show hidden and system files" and "Show file extensions" under "File Explorer".
   - Enable local powershell scripts to run without signing under "PowerShell".
   - Enable Sudo.
3. Add the following environment variables:
   - `XDG_CONFIG_HOME` -> `$Env:USERPROFILE\.config`
   - `XDG_DATA_HOME` -> `$Env:USERPROFILE\.config`
   - `XDG_STATE_HOME` -> `$Env:USERPROFILE\.config`
   - `XDG_CACHE_HOME` -> `$Env:USERPROFILE\.config\temp`
4. My PowerToys setup is as follows:
   - Run with an activation shortcut of `win+shift+backspace`, input smoothing disabled, clear previous query on launch
     enabled, preferred monitor primary, all plugins off except "Program" and "Windows System Commands" - this behaves
     just like the windows run dialog but without cortana, searching the internet or any other annoyances and the
     ability to type shutdown, restart, etc.
   - Color Picker with an activation shortcut of `win+shift+c` and HEX, RGB and VEC4 enabled.
   - Mouse Jump with an activation shortcut of `win+shift+d` and a max size of `1600x1200`.
   - Screen Ruler with an activation shortcut of `win+shift+p` and default measure style of `Spacing`.
   - Text Extractor with an activation shortcut of `win+shift+t`.
   - File Locksmith enabled.
5. You can right click your desktop and go to "View" and then "Hide desktop icons" to have a clean desktop.

# Komorebi
### Dependencies
- Komorebi &rightarrow; Run `winget install LGUG2Z.komorebi` and add the environment variable `KOMOREBI_CONFIG_HOME`
  -> `$Env:USERPROFILE\.config\komorebi`.
- Yasb &rightarrow; Run `winget install --id AmN.yasb`.
- AutoHotkey &rightarrow; Run `winget install AutoHotkey.AutoHotkey`.
- ToggleRoundedCorners &rightarrow; Download the portable executable from
  [here](https://github.com/oberrich/win11-toggle-rounded-corners/releases) and rename it to `trc.exe`. Place it in
  `C:\Program Files\ToggleRoundedCorners` and put that folder in your path.

### Setup
1. Run `Set-ItemProperty 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -Value 1` in
   PowerShellCore as an admin.
2. Open control panel and go to the "Ease of Access Center" then "Make the computer easier to see" - enable "Turn off
   all unnecessary animations (when possible)".
3. Press Windows + I and search `taskbar`, go to taskbar settings and turn on "Automatically hide the taskbar" under the
   taskbar behaviours.
4. Search `multitasking` and turn off "Snap windows".
5. Paste `komorebi` into your config. In `komorebi.json` ensure that the correct amount of monitors are configured.
6. Paste `yasb` into your config. Add the directory containing `yasbc.exe` to your path (`C:\Program Files\YASB` by
   default).
7. Paste `ahk` into your config. Right click `wm.ahk` and create a shortcut, then rename that shortcut to just `wm` and
   create a copy of it, one should be moved to `C:\ProgramData\Microsoft\Windows\Start Menu\Programs` and the other to
   that folder's sub-directory `Start-up` (or `Startup`). Now it will be run at startup and is accessible from the start
   menu in case you need to restart the manager, and all three processes can be killed from the task manager.
8. Restart your PC.

> [!TIP]
> Keybinds and commands to run on startup can be configured in `wm.ahk`, the status bar can be configured in the Yasb
> `config.yaml` and `styles.css` files, and the window manager can be configured by Komorebi's `komorebi.json`,
> `applications.json` and any `.json` files for custom layouts.

# Terminal
### Dependencies
- NerdFont &rightarrow; Download from [here](https://www.nerdfonts.com/font-downloads) (I use CaskaydiaCove), then in
  explorer select all `.ttf` files and right click them, now select "Install". After that you can delete the files.
- Windows Terminal &rightarrow; Run `winget install --id Microsoft.WindowsTerminal`.
- PowerShellCore &rightarrow; Run `winget install --id Microsoft.Powershell --source winget`.
- Git &rightarrow; Run `winget install --id Git.Git --source winget`.
- Github CLI &rightarrow; Run `winget install --id GitHub.cli`.
- fd &rightarrow; Run `winget install --id sharkdp.fd --source winget`.
- bat &rightarrow; Run `winget install sharkdp.bat` and add the environment variable `BAT_THEME` -> `Visual Studio
  Dark+`. You can choose any of the themes from `bat --list-themes`.
- fzf &rightarrow; Run `winget install junegunn.fzf`.

### Setup
1. Paste `terminal` into your config and change the font settings account for whatever NerdFont you installed. Also,
   make sure you add whatever profiles you want to use other than the three that i have set up. Each new profile needs a
   unique guid - you can generate one by running `[guid]::NewGuid()` in PowerShellCore.
2. Find the location of the windows terminal settings file (it's different per machine) - open that directory and delete
   `settings.json` - then run this command in PowerShellCore: `New-Item -ItemType SymbolicLink -Path ".\settings.json"
   -Target "$env:USERPROFILE\.config\terminal\settings.json"`.
3. Paste `pwsh` into your config, then run `notepad $PROFILE` and paste this line into the file that is opened (you may
   have to create the file first if it doesn't exist): `. $Env:USERPROFILE"\.config\pwsh\main.ps1"`.
4. Go back to `pwsh\main.ps1` and remove the line that sources `personal.ps1`, and delete that file too as it is
   specific to me. Other than that, skim the rest of the files and remove anything you know you won't need - everything
   is commented or self-explanatory so you can be sure of what you're doing.
5. Run `git config --system core.longpaths true` and ensure that `[PATH_TO_GIT]\bin` is in your path. After that you can
   run `git config --global user.name "[YOUR_NAME]"` and `git config --global user.email "[YOUR_EMAIL]"`, followed by
   `git config --global core.autocrlf true` and `git config --global core.editor nvim` if you want.
6. Run `gh auth login` and follow the instructions to authenticate your local machine with your GitHub account. After
   that you can run `gh config set editor nvim` if you want.

# Neovim
> [!IMPORTANT]
> This section requires completion of the terminal setup first.

### Dependencies
- Microsoft Visual C++ 2015-2022 Redistributable (x64) &rightarrow; Download from
  [here](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) and run the
  installation wizard.
- MinGW &rightarrow; Download from [here](https://winlibs.com/) and put the contents in `C:\Program Files\MinGW` (I
  recommend 64-bit with POSIX threads for general purpose use). Add `C:\Program Files\MinGW\bin` to your path.
- Make &rightarrow; Run `winget install --id ezwinports.make`.
- CMake &rightarrow; Run `winget install --id Kitware.CMake`.
- Python &rightarrow; Run `winget install --id Python.Python.3.10`.
- NodeJS &rightarrow; Run `winget install OpenJS.NodeJS`.
- ripgrep &rightarrow; Run `winget install BurntSushi.ripgrep.MSVC`.
- Neovim &rightarrow; Run `winget install neovim --version 0.12.0` and add the environment variables `NVIM_LOG_FILE` ->
  `$Env:USERPROFILE\.config\nvim-data\nvim.log` and `EDITOR` -> `nvim`.
- Python Provider &rightarrow; Run `pip install pynvim --upgrade`.
- NodeJS Provider &rightarrow; Run `npm install -g neovim`.
- TreeSitterCLI &rightarrow; Run `npm install -g tree-sitter-cli`.

### Setup
After completing the dependencies for this section, I recommend manually recreating `nvim` on your machine rather than
just pasting it in, because this will allow you to single out any unexpected errors as they happen.

You should start with the top level `init.lua` and then `lua\main\init.lua`. Then you can create `lua\main\util.lua`,
`lua\main\set.lua` and `lua\main\map.lua` and paste the config into each. After creating an empty `lua\plugin\init.lua`,
restart neovim and there should be no error messages.

Now, in the order they are listed in that file, start creating the plugin files one by one, following this pattern:
1. Create and populate the file in `lua\plugin\[PLUGIN].lua`.
2. Add `require("plugin.[PLUGIN]")` to `lua\plugin\init.lua` (order matters in this file).
3. Customize the file to your liking, then restart neovim.
4. Test the plugin.

The following plugins have some extra things you need to know:
- Treesitter &rightarrow; After following the pattern, you should see it compiling languages - don't touch your keyboard
  until this is finished, though it is common to get errors at this point, if you do, generally restarting neovim a few
  times and deleting any directories manually that it says it doesn't have permission to delete will let them all figure
  themselves out. However if you get an error along the lines of `[LANGUAGE].so is not a valid Win32 app`, this means
  your version of MinGW does not match your operating system. After fixing the issue you can run `:TSInstall [LANGUAGE]`
  to recompile it.
- Mason &rightarrow; After following the pattern, you should see it downloading all the dependencies specified in the
  mason file - view all the available downloads by running `:Mason`.

> [!TIP]
> All keybinds and settings can be edited at `lua\main\map.lua`, `lua\main\set.lua` or the respective
> `lua\plugin\[PLUGIN].lua` files and you can go into deeper detail inside `lua\main\util.lua`. Furthermore, all
> language specific settings and mappings can be edited at `lua\plugin\language.lua`.

# Opencode
> [!IMPORTANT]
> This section requires completion of the terminal setup first.

### Dependencies
- Opencode &rightarrow; Run `npm install -g opencode-ai`.

### Setup
You only need to paste the `opencode` folder into your config, run opencode and connect whatever providers you want to
use.

> [!TIP]
> `AGENTS.md` is the prompt that every agent will be fed and `opencode.json` contains the bulk of the configuration of
> opencode. The `command` folder contains custom /command definitions, and the `themes` folder contains custom themes.

# Firefox
### Dependencies
- Firefox &rightarrow; Download from [here](https://www.mozilla.org/en-GB/firefox/new/).
- Tridactyl &rightarrow; Go
  [here](https://addons.mozilla.org/en-US/firefox/addon/tridactyl-vim/?utm_source=github.com&utm_content=readme.md) on
  Firefox.

### Setup
First, make firefox your default browser and make the folder containing `firefox.exe` an environment variable
(`C:\Program Files\Mozilla Firefox` by default). After that go to Firefox settings and change the following:
- Home &rightarrow; Homepage and new windows &rightarrow; Custom URLs... &rightarrow; Open a new tab, then close it and
  go to your history, copy the url of that closed tab and paste it into the field - it should be of the form
  `moz-extension://[NUMBERS]/static/newtab.html`.
- Search &rightarrow; Default search engine = Google.
- Now go to the url `about:config` and search for `full-screen-api.transition-duration.enter` and
  `full-screen-api.transition-duration.leave` and change both to `0 0` for quicker transitions when fullscreening.
- Scan the rest of the settings and disable things you don't want that will slow down the browser.
- Optionally, you can install the black
  [theme](https://addons.mozilla.org/en-GB/firefox/addon/black21/?utm_source=addons.mozilla.org&utm_medium=referral&utm_content=search)
  I use or find your own on their themes [page](https://addons.mozilla.org/firefox/themes).

Using Tridactyl, press `:` and type the following commands:
- `colorscheme midnight`.
- `set newtab about:newtab`.
- `set searchengine google`.
- `set modeindicatorshowkeys true`.
- `set modeindicatormodes
  {"normal":"true","insert":"true","input":"true","ignore":"false","ex":"true","hint":"true","visual":"true"}`.

> [!TIP]
> You can go [here](https://github.com/tridactyl/tridactyl?tab=readme-ov-file#highlighted-features) to view all the most
> important Tridactyl bindings.

# Extras
VimForVoyager &rightarrow; Go [here](https://github.com/ConnorSweeneyDev/VimForVoyager) and follow the setup guide for a
native Vim toggle for QMK keyboards.

Dependencies &rightarrow; Download from [here](https://github.com/lucasg/Dependencies) and put the contents in
`C:\Program Files\Dependencies`, make that folder an environment variable, then right click `DependenciesGui.exe` and
select "Create shortcut" and rename it to `Dependencies`, then move that to `C:\ProgramData\Microsoft\Windows\Start
Menu\Programs`.

WinLister &rightarrow; Go [here](https://www.nirsoft.net/utils/winlister.html) and click "Download WinLister 64-bit",
move the executable to `C:\Program Files\WinLister`, then right click `winlister.exe` and select "Create shortcut", then
rename it to `WinLister` and place this shortcut in `C:\ProgramData\Microsoft\Windows\Start Menu\Programs`.

Everything &rightarrow; Download the portable zip from [here](https://www.voidtools.com/) and put the contents in
`C:\Program Files\Everything`. Right click `Everything.exe` and select "Create shortcut", then rename it to `Everything`
and place this shortcut in `C:\ProgramData\Microsoft\Windows\Start Menu\Programs`.

Mp3tag &rightarrow; Download from [here](https://www.mp3tag.de/en/download.html) and go through the installation wizard.

Better Cursor &rightarrow; Go [here](https://jepricreations.com) for a more fitting cursor. After buying, extract the
contents to a known location and go to the version you desire, right click the `install.inf` file, click install and
accept any dialogs that appear.

.config

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README